Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-storsimple8000series

Index

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

AccessControlRecordsBeginCreateOrUpdateResponse

AccessControlRecordsBeginCreateOrUpdateResponse: AccessControlRecord & object

Contains response data for the beginCreateOrUpdate operation.

AccessControlRecordsCreateOrUpdateResponse

AccessControlRecordsCreateOrUpdateResponse: AccessControlRecord & object

Contains response data for the createOrUpdate operation.

AccessControlRecordsGetResponse

AccessControlRecordsGetResponse: AccessControlRecord & object

Contains response data for the get operation.

AccessControlRecordsListByManagerResponse

AccessControlRecordsListByManagerResponse: AccessControlRecordList & object

Contains response data for the listByManager operation.

AlertEmailNotificationStatus

AlertEmailNotificationStatus: "Enabled" | "Disabled"

Defines values for AlertEmailNotificationStatus. Possible values include: 'Enabled', 'Disabled'

readonly
enum

{string}

AlertScope

AlertScope: "Resource" | "Device"

Defines values for AlertScope. Possible values include: 'Resource', 'Device'

readonly
enum

{string}

AlertSeverity

AlertSeverity: "Informational" | "Warning" | "Critical"

Defines values for AlertSeverity. Possible values include: 'Informational', 'Warning', 'Critical'

readonly
enum

{string}

AlertSourceType

AlertSourceType: "Resource" | "Device"

Defines values for AlertSourceType. Possible values include: 'Resource', 'Device'

readonly
enum

{string}

AlertStatus

AlertStatus: "Active" | "Cleared"

Defines values for AlertStatus. Possible values include: 'Active', 'Cleared'

readonly
enum

{string}

AlertsListByManagerNextResponse

AlertsListByManagerNextResponse: AlertList & object

Contains response data for the listByManagerNext operation.

AlertsListByManagerResponse

AlertsListByManagerResponse: AlertList & object

Contains response data for the listByManager operation.

AuthenticationType

AuthenticationType: "Invalid" | "None" | "Basic" | "NTLM"

Defines values for AuthenticationType. Possible values include: 'Invalid', 'None', 'Basic', 'NTLM'

readonly
enum

{string}

AuthorizationEligibility

AuthorizationEligibility: "InEligible" | "Eligible"

Defines values for AuthorizationEligibility. Possible values include: 'InEligible', 'Eligible'

readonly
enum

{string}

AuthorizationStatus

AuthorizationStatus: "Disabled" | "Enabled"

Defines values for AuthorizationStatus. Possible values include: 'Disabled', 'Enabled'

readonly
enum

{string}

BackupJobCreationType

BackupJobCreationType: "Adhoc" | "BySchedule" | "BySSM"

Defines values for BackupJobCreationType. Possible values include: 'Adhoc', 'BySchedule', 'BySSM'

readonly
enum

{string}

BackupPoliciesBeginCreateOrUpdateResponse

BackupPoliciesBeginCreateOrUpdateResponse: BackupPolicy & object

Contains response data for the beginCreateOrUpdate operation.

BackupPoliciesCreateOrUpdateResponse

BackupPoliciesCreateOrUpdateResponse: BackupPolicy & object

Contains response data for the createOrUpdate operation.

BackupPoliciesGetResponse

BackupPoliciesGetResponse: BackupPolicy & object

Contains response data for the get operation.

BackupPoliciesListByDeviceResponse

BackupPoliciesListByDeviceResponse: BackupPolicyList & object

Contains response data for the listByDevice operation.

BackupPolicyCreationType

BackupPolicyCreationType: "BySaaS" | "BySSM"

Defines values for BackupPolicyCreationType. Possible values include: 'BySaaS', 'BySSM'

readonly
enum

{string}

BackupSchedulesBeginCreateOrUpdateResponse

BackupSchedulesBeginCreateOrUpdateResponse: BackupSchedule & object

Contains response data for the beginCreateOrUpdate operation.

BackupSchedulesCreateOrUpdateResponse

BackupSchedulesCreateOrUpdateResponse: BackupSchedule & object

Contains response data for the createOrUpdate operation.

BackupSchedulesGetResponse

BackupSchedulesGetResponse: BackupSchedule & object

Contains response data for the get operation.

BackupSchedulesListByBackupPolicyResponse

BackupSchedulesListByBackupPolicyResponse: BackupScheduleList & object

Contains response data for the listByBackupPolicy operation.

BackupStatus

BackupStatus: "Enabled" | "Disabled"

Defines values for BackupStatus. Possible values include: 'Enabled', 'Disabled'

readonly
enum

{string}

BackupType

BackupType: "LocalSnapshot" | "CloudSnapshot"

Defines values for BackupType. Possible values include: 'LocalSnapshot', 'CloudSnapshot'

readonly
enum

{string}

BackupsListByDeviceNextResponse

BackupsListByDeviceNextResponse: BackupList & object

Contains response data for the listByDeviceNext operation.

BackupsListByDeviceResponse

BackupsListByDeviceResponse: BackupList & object

Contains response data for the listByDevice operation.

BandwidthSettingsBeginCreateOrUpdateResponse

BandwidthSettingsBeginCreateOrUpdateResponse: BandwidthSetting & object

Contains response data for the beginCreateOrUpdate operation.

BandwidthSettingsCreateOrUpdateResponse

BandwidthSettingsCreateOrUpdateResponse: BandwidthSetting & object

Contains response data for the createOrUpdate operation.

BandwidthSettingsGetResponse

BandwidthSettingsGetResponse: BandwidthSetting & object

Contains response data for the get operation.

BandwidthSettingsListByManagerResponse

BandwidthSettingsListByManagerResponse: BandwidthSettingList & object

Contains response data for the listByManager operation.

CloudAppliancesListSupportedConfigurationsResponse

CloudAppliancesListSupportedConfigurationsResponse: CloudApplianceConfigurationList & object

Contains response data for the listSupportedConfigurations operation.

ControllerId

ControllerId: "Unknown" | "None" | "Controller0" | "Controller1"

Defines values for ControllerId. Possible values include: 'Unknown', 'None', 'Controller0', 'Controller1'

readonly
enum

{string}

ControllerPowerStateAction

ControllerPowerStateAction: "Start" | "Restart" | "Shutdown"

Defines values for ControllerPowerStateAction. Possible values include: 'Start', 'Restart', 'Shutdown'

readonly
enum

{string}

ControllerStatus

ControllerStatus: "NotPresent" | "PoweredOff" | "Ok" | "Recovering" | "Warning" | "Failure"

Defines values for ControllerStatus. Possible values include: 'NotPresent', 'PoweredOff', 'Ok', 'Recovering', 'Warning', 'Failure'

readonly
enum

{string}

DayOfWeek

DayOfWeek: "Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday"

Defines values for DayOfWeek. Possible values include: 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'

readonly
enum

{string}

DeviceConfigurationStatus

DeviceConfigurationStatus: "Complete" | "Pending"

Defines values for DeviceConfigurationStatus. Possible values include: 'Complete', 'Pending'

readonly
enum

{string}

DeviceSettingsBeginCreateOrUpdateAlertSettingsResponse

DeviceSettingsBeginCreateOrUpdateAlertSettingsResponse: AlertSettings & object

Contains response data for the beginCreateOrUpdateAlertSettings operation.

DeviceSettingsBeginCreateOrUpdateTimeSettingsResponse

DeviceSettingsBeginCreateOrUpdateTimeSettingsResponse: TimeSettings & object

Contains response data for the beginCreateOrUpdateTimeSettings operation.

DeviceSettingsBeginUpdateNetworkSettingsResponse

DeviceSettingsBeginUpdateNetworkSettingsResponse: NetworkSettings & object

Contains response data for the beginUpdateNetworkSettings operation.

DeviceSettingsBeginUpdateSecuritySettingsResponse

DeviceSettingsBeginUpdateSecuritySettingsResponse: SecuritySettings & object

Contains response data for the beginUpdateSecuritySettings operation.

DeviceSettingsCreateOrUpdateAlertSettingsResponse

DeviceSettingsCreateOrUpdateAlertSettingsResponse: AlertSettings & object

Contains response data for the createOrUpdateAlertSettings operation.

DeviceSettingsCreateOrUpdateTimeSettingsResponse

DeviceSettingsCreateOrUpdateTimeSettingsResponse: TimeSettings & object

Contains response data for the createOrUpdateTimeSettings operation.

DeviceSettingsGetAlertSettingsResponse

DeviceSettingsGetAlertSettingsResponse: AlertSettings & object

Contains response data for the getAlertSettings operation.

DeviceSettingsGetNetworkSettingsResponse

DeviceSettingsGetNetworkSettingsResponse: NetworkSettings & object

Contains response data for the getNetworkSettings operation.

DeviceSettingsGetSecuritySettingsResponse

DeviceSettingsGetSecuritySettingsResponse: SecuritySettings & object

Contains response data for the getSecuritySettings operation.

DeviceSettingsGetTimeSettingsResponse

DeviceSettingsGetTimeSettingsResponse: TimeSettings & object

Contains response data for the getTimeSettings operation.

DeviceSettingsUpdateNetworkSettingsResponse

DeviceSettingsUpdateNetworkSettingsResponse: NetworkSettings & object

Contains response data for the updateNetworkSettings operation.

DeviceSettingsUpdateSecuritySettingsResponse

DeviceSettingsUpdateSecuritySettingsResponse: SecuritySettings & object

Contains response data for the updateSecuritySettings operation.

DeviceStatus

DeviceStatus: "Unknown" | "Online" | "Offline" | "Deactivated" | "RequiresAttention" | "MaintenanceMode" | "Creating" | "Provisioning" | "Deactivating" | "Deleted" | "ReadyToSetup"

Defines values for DeviceStatus. Possible values include: 'Unknown', 'Online', 'Offline', 'Deactivated', 'RequiresAttention', 'MaintenanceMode', 'Creating', 'Provisioning', 'Deactivating', 'Deleted', 'ReadyToSetup'

readonly
enum

{string}

DeviceType

DeviceType: "Invalid" | "Series8000VirtualAppliance" | "Series8000PhysicalAppliance"

Defines values for DeviceType. Possible values include: 'Invalid', 'Series8000VirtualAppliance', 'Series8000PhysicalAppliance'

readonly
enum

{string}

DevicesGetResponse

DevicesGetResponse: Device & object

Contains response data for the get operation.

DevicesGetUpdateSummaryResponse

DevicesGetUpdateSummaryResponse: Updates & object

Contains response data for the getUpdateSummary operation.

DevicesListByManagerResponse

DevicesListByManagerResponse: DeviceList & object

Contains response data for the listByManager operation.

DevicesListFailoverSetsResponse

DevicesListFailoverSetsResponse: FailoverSetsList & object

Contains response data for the listFailoverSets operation.

DevicesListFailoverTargetsResponse

DevicesListFailoverTargetsResponse: FailoverTargetsList & object

Contains response data for the listFailoverTargets operation.

DevicesListMetricDefinitionResponse

DevicesListMetricDefinitionResponse: MetricDefinitionList & object

Contains response data for the listMetricDefinition operation.

DevicesListMetricsResponse

DevicesListMetricsResponse: MetricList & object

Contains response data for the listMetrics operation.

DevicesUpdateResponse

DevicesUpdateResponse: Device & object

Contains response data for the update operation.

EncryptionAlgorithm

EncryptionAlgorithm: "None" | "AES256" | "RSAES_PKCS1_v_1_5"

Defines values for EncryptionAlgorithm. Possible values include: 'None', 'AES256', 'RSAES_PKCS1_v_1_5'

readonly
enum

{string}

EncryptionStatus

EncryptionStatus: "Enabled" | "Disabled"

Defines values for EncryptionStatus. Possible values include: 'Enabled', 'Disabled'

readonly
enum

{string}

FeatureSupportStatus

FeatureSupportStatus: "NotAvailable" | "UnsupportedDeviceVersion" | "Supported"

Defines values for FeatureSupportStatus. Possible values include: 'NotAvailable', 'UnsupportedDeviceVersion', 'Supported'

readonly
enum

{string}

HardwareComponentGroupsListByDeviceResponse

HardwareComponentGroupsListByDeviceResponse: HardwareComponentGroupList & object

Contains response data for the listByDevice operation.

HardwareComponentStatus

HardwareComponentStatus: "Unknown" | "NotPresent" | "PoweredOff" | "Ok" | "Recovering" | "Warning" | "Failure"

Defines values for HardwareComponentStatus. Possible values include: 'Unknown', 'NotPresent', 'PoweredOff', 'Ok', 'Recovering', 'Warning', 'Failure'

readonly
enum

{string}

ISCSIAndCloudStatus

ISCSIAndCloudStatus: "Disabled" | "IscsiEnabled" | "CloudEnabled" | "IscsiAndCloudEnabled"

Defines values for ISCSIAndCloudStatus. Possible values include: 'Disabled', 'IscsiEnabled', 'CloudEnabled', 'IscsiAndCloudEnabled'

readonly
enum

{string}

InEligibilityCategory

InEligibilityCategory: "DeviceNotOnline" | "NotSupportedAppliance" | "RolloverPending"

Defines values for InEligibilityCategory. Possible values include: 'DeviceNotOnline', 'NotSupportedAppliance', 'RolloverPending'

readonly
enum

{string}

JobStatus

JobStatus: "Running" | "Succeeded" | "Failed" | "Canceled"

Defines values for JobStatus. Possible values include: 'Running', 'Succeeded', 'Failed', 'Canceled'

readonly
enum

{string}

JobType

JobType: "ScheduledBackup" | "ManualBackup" | "RestoreBackup" | "CloneVolume" | "FailoverVolumeContainers" | "CreateLocallyPinnedVolume" | "ModifyVolume" | "InstallUpdates" | "SupportPackageLogs" | "CreateCloudAppliance"

Defines values for JobType. Possible values include: 'ScheduledBackup', 'ManualBackup', 'RestoreBackup', 'CloneVolume', 'FailoverVolumeContainers', 'CreateLocallyPinnedVolume', 'ModifyVolume', 'InstallUpdates', 'SupportPackageLogs', 'CreateCloudAppliance'

readonly
enum

{string}

JobsGetResponse

JobsGetResponse: Job & object

Contains response data for the get operation.

JobsListByDeviceNextResponse

JobsListByDeviceNextResponse: JobList & object

Contains response data for the listByDeviceNext operation.

JobsListByDeviceResponse

JobsListByDeviceResponse: JobList & object

Contains response data for the listByDevice operation.

JobsListByManagerNextResponse

JobsListByManagerNextResponse: JobList & object

Contains response data for the listByManagerNext operation.

JobsListByManagerResponse

JobsListByManagerResponse: JobList & object

Contains response data for the listByManager operation.

KeyRolloverStatus

KeyRolloverStatus: "Required" | "NotRequired"

Defines values for KeyRolloverStatus. Possible values include: 'Required', 'NotRequired'

readonly
enum

{string}

Kind

Kind: "Series8000"

Defines values for Kind. Possible values include: 'Series8000'

readonly
enum

{string}

ManagerType

ManagerType: "GardaV1" | "HelsinkiV1"

Defines values for ManagerType. Possible values include: 'GardaV1', 'HelsinkiV1'

readonly
enum

{string}

ManagersCreateExtendedInfoResponse

ManagersCreateExtendedInfoResponse: ManagerExtendedInfo & object

Contains response data for the createExtendedInfo operation.

ManagersCreateOrUpdateResponse

ManagersCreateOrUpdateResponse: Manager & object

Contains response data for the createOrUpdate operation.

ManagersGetActivationKeyResponse

ManagersGetActivationKeyResponse: Key & object

Contains response data for the getActivationKey operation.

ManagersGetDevicePublicEncryptionKeyResponse

ManagersGetDevicePublicEncryptionKeyResponse: PublicKey & object

Contains response data for the getDevicePublicEncryptionKey operation.

ManagersGetEncryptionSettingsResponse

ManagersGetEncryptionSettingsResponse: EncryptionSettings & object

Contains response data for the getEncryptionSettings operation.

ManagersGetExtendedInfoResponse

ManagersGetExtendedInfoResponse: ManagerExtendedInfo & object

Contains response data for the getExtendedInfo operation.

ManagersGetPublicEncryptionKeyResponse

ManagersGetPublicEncryptionKeyResponse: SymmetricEncryptedSecret & object

Contains response data for the getPublicEncryptionKey operation.

ManagersGetResponse

ManagersGetResponse: Manager & object

Contains response data for the get operation.

ManagersListByResourceGroupResponse

ManagersListByResourceGroupResponse: ManagerList & object

Contains response data for the listByResourceGroup operation.

ManagersListFeatureSupportStatusResponse

ManagersListFeatureSupportStatusResponse: FeatureList & object

Contains response data for the listFeatureSupportStatus operation.

ManagersListMetricDefinitionResponse

ManagersListMetricDefinitionResponse: MetricDefinitionList & object

Contains response data for the listMetricDefinition operation.

ManagersListMetricsResponse

ManagersListMetricsResponse: MetricList & object

Contains response data for the listMetrics operation.

ManagersListResponse

ManagersListResponse: ManagerList & object

Contains response data for the list operation.

ManagersRegenerateActivationKeyResponse

ManagersRegenerateActivationKeyResponse: Key & object

Contains response data for the regenerateActivationKey operation.

ManagersUpdateExtendedInfoResponse

ManagersUpdateExtendedInfoResponse: ManagerExtendedInfo & object

Contains response data for the updateExtendedInfo operation.

ManagersUpdateResponse

ManagersUpdateResponse: Manager & object

Contains response data for the update operation.

MetricAggregationType

MetricAggregationType: "Average" | "Last" | "Maximum" | "Minimum" | "None" | "Total"

Defines values for MetricAggregationType. Possible values include: 'Average', 'Last', 'Maximum', 'Minimum', 'None', 'Total'

readonly
enum

{string}

MetricUnit

MetricUnit: "Bytes" | "BytesPerSecond" | "Count" | "CountPerSecond" | "Percent" | "Seconds"

Defines values for MetricUnit. Possible values include: 'Bytes', 'BytesPerSecond', 'Count', 'CountPerSecond', 'Percent', 'Seconds'

readonly
enum

{string}

MonitoringStatus

MonitoringStatus: "Enabled" | "Disabled"

Defines values for MonitoringStatus. Possible values include: 'Enabled', 'Disabled'

readonly
enum

{string}

NetInterfaceId

NetInterfaceId: "Invalid" | "Data0" | "Data1" | "Data2" | "Data3" | "Data4" | "Data5"

Defines values for NetInterfaceId. Possible values include: 'Invalid', 'Data0', 'Data1', 'Data2', 'Data3', 'Data4', 'Data5'

readonly
enum

{string}

NetInterfaceStatus

NetInterfaceStatus: "Enabled" | "Disabled"

Defines values for NetInterfaceStatus. Possible values include: 'Enabled', 'Disabled'

readonly
enum

{string}

NetworkMode

NetworkMode: "Invalid" | "IPV4" | "IPV6" | "BOTH"

Defines values for NetworkMode. Possible values include: 'Invalid', 'IPV4', 'IPV6', 'BOTH'

readonly
enum

{string}

OperationStatus

OperationStatus: "None" | "Updating" | "Deleting" | "Restoring"

Defines values for OperationStatus. Possible values include: 'None', 'Updating', 'Deleting', 'Restoring'

readonly
enum

{string}

OperationsListNextResponse

OperationsListNextResponse: AvailableProviderOperationList & object

Contains response data for the listNext operation.

OperationsListResponse

OperationsListResponse: AvailableProviderOperationList & object

Contains response data for the list operation.

OwnerShipStatus

OwnerShipStatus: "Owned" | "NotOwned"

Defines values for OwnerShipStatus. Possible values include: 'Owned', 'NotOwned'

readonly
enum

{string}

RecurrenceType

RecurrenceType: "Minutes" | "Hourly" | "Daily" | "Weekly"

Defines values for RecurrenceType. Possible values include: 'Minutes', 'Hourly', 'Daily', 'Weekly'

readonly
enum

{string}

RemoteManagementModeConfiguration

RemoteManagementModeConfiguration: "Unknown" | "Disabled" | "HttpsEnabled" | "HttpsAndHttpEnabled"

Defines values for RemoteManagementModeConfiguration. Possible values include: 'Unknown', 'Disabled', 'HttpsEnabled', 'HttpsAndHttpEnabled'

readonly
enum

{string}

ScheduleStatus

ScheduleStatus: "Enabled" | "Disabled"

Defines values for ScheduleStatus. Possible values include: 'Enabled', 'Disabled'

readonly
enum

{string}

ScheduledBackupStatus

ScheduledBackupStatus: "Disabled" | "Enabled"

Defines values for ScheduledBackupStatus. Possible values include: 'Disabled', 'Enabled'

readonly
enum

{string}

SslStatus

SslStatus: "Enabled" | "Disabled"

Defines values for SslStatus. Possible values include: 'Enabled', 'Disabled'

readonly
enum

{string}

StorageAccountCredentialsBeginCreateOrUpdateResponse

StorageAccountCredentialsBeginCreateOrUpdateResponse: StorageAccountCredential & object

Contains response data for the beginCreateOrUpdate operation.

StorageAccountCredentialsCreateOrUpdateResponse

StorageAccountCredentialsCreateOrUpdateResponse: StorageAccountCredential & object

Contains response data for the createOrUpdate operation.

StorageAccountCredentialsGetResponse

StorageAccountCredentialsGetResponse: StorageAccountCredential & object

Contains response data for the get operation.

StorageAccountCredentialsListByManagerResponse

StorageAccountCredentialsListByManagerResponse: StorageAccountCredentialList & object

Contains response data for the listByManager operation.

TargetEligibilityResultCode

TargetEligibilityResultCode: "TargetAndSourceCannotBeSameError" | "TargetIsNotOnlineError" | "TargetSourceIncompatibleVersionError" | "LocalToTieredVolumesConversionWarning" | "TargetInsufficientCapacityError" | "TargetInsufficientLocalVolumeMemoryError" | "TargetInsufficientTieredVolumeMemoryError"

Defines values for TargetEligibilityResultCode. Possible values include: 'TargetAndSourceCannotBeSameError', 'TargetIsNotOnlineError', 'TargetSourceIncompatibleVersionError', 'LocalToTieredVolumesConversionWarning', 'TargetInsufficientCapacityError', 'TargetInsufficientLocalVolumeMemoryError', 'TargetInsufficientTieredVolumeMemoryError'

readonly
enum

{string}

TargetEligibilityStatus

TargetEligibilityStatus: "NotEligible" | "Eligible"

Defines values for TargetEligibilityStatus. Possible values include: 'NotEligible', 'Eligible'

readonly
enum

{string}

VirtualMachineApiType

VirtualMachineApiType: "Classic" | "Arm"

Defines values for VirtualMachineApiType. Possible values include: 'Classic', 'Arm'

readonly
enum

{string}

VolumeContainersBeginCreateOrUpdateResponse

VolumeContainersBeginCreateOrUpdateResponse: VolumeContainer & object

Contains response data for the beginCreateOrUpdate operation.

VolumeContainersCreateOrUpdateResponse

VolumeContainersCreateOrUpdateResponse: VolumeContainer & object

Contains response data for the createOrUpdate operation.

VolumeContainersGetResponse

VolumeContainersGetResponse: VolumeContainer & object

Contains response data for the get operation.

VolumeContainersListByDeviceResponse

VolumeContainersListByDeviceResponse: VolumeContainerList & object

Contains response data for the listByDevice operation.

VolumeContainersListMetricDefinitionResponse

VolumeContainersListMetricDefinitionResponse: MetricDefinitionList & object

Contains response data for the listMetricDefinition operation.

VolumeContainersListMetricsResponse

VolumeContainersListMetricsResponse: MetricList & object

Contains response data for the listMetrics operation.

VolumeStatus

VolumeStatus: "Online" | "Offline"

Defines values for VolumeStatus. Possible values include: 'Online', 'Offline'

readonly
enum

{string}

VolumeType

VolumeType: "Tiered" | "Archival" | "LocallyPinned"

Defines values for VolumeType. Possible values include: 'Tiered', 'Archival', 'LocallyPinned'

readonly
enum

{string}

VolumesBeginCreateOrUpdateResponse

VolumesBeginCreateOrUpdateResponse: Volume & object

Contains response data for the beginCreateOrUpdate operation.

VolumesCreateOrUpdateResponse

VolumesCreateOrUpdateResponse: Volume & object

Contains response data for the createOrUpdate operation.

VolumesGetResponse

VolumesGetResponse: Volume & object

Contains response data for the get operation.

VolumesListByDeviceResponse

VolumesListByDeviceResponse: VolumeList & object

Contains response data for the listByDevice operation.

VolumesListByVolumeContainerResponse

VolumesListByVolumeContainerResponse: VolumeList & object

Contains response data for the listByVolumeContainer operation.

VolumesListMetricDefinitionResponse

VolumesListMetricDefinitionResponse: MetricDefinitionList & object

Contains response data for the listMetricDefinition operation.

VolumesListMetricsResponse

VolumesListMetricsResponse: MetricList & object

Contains response data for the listMetrics operation.

Variables

Const BaseResource

BaseResource: CompositeMapper = BaseResourceMapper

Const CloudError

CloudError: CompositeMapper = CloudErrorMapper

Object literals

Const AccessControlRecord

AccessControlRecord: object
interface

An interface representing AccessControlRecord. The access control record.

extends

BaseModel

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

initiatorName

initiatorName: string
member

{string} initiatorName The iSCSI initiator name (IQN).

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AccessControlRecord"

Optional volumeCount

volumeCount: undefined | number
member

{number} [volumeCount] The number of volumes using the access control record. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "AccessControlRecord"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

initiatorName

initiatorName: object

required

required: true = true

serializedName

serializedName: string = "properties.initiatorName"

type

type: object

name

name: "String" = "String"

volumeCount

volumeCount: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.volumeCount"

type

type: object

name

name: "Number" = "Number"

Const AccessControlRecordList

AccessControlRecordList: object
interface

An interface representing the AccessControlRecordList. The collection of access control records.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "AccessControlRecordList"

__@iterator

  • __@iterator(): IterableIterator<AccessControlRecord>
  • Iterator

    Returns IterableIterator<AccessControlRecord>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<AccessControlRecord>[]): AccessControlRecord[]
  • concat(...items: (T | ConcatArray<T>)[]): AccessControlRecord[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<AccessControlRecord>[]

      Additional items to add to the end of array1.

    Returns AccessControlRecord[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns AccessControlRecord[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, AccessControlRecord]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, AccessControlRecord]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: AccessControlRecord, index: number, array: AccessControlRecord[]): boolean
        • Parameters

          • value: AccessControlRecord
          • index: number
          • array: AccessControlRecord[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: AccessControlRecord, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: AccessControlRecord

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): AccessControlRecord[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: AccessControlRecord

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: AccessControlRecord, index: number, array: AccessControlRecord[]): boolean
        • Parameters

          • value: AccessControlRecord
          • index: number
          • array: AccessControlRecord[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: AccessControlRecord, index: number, array: AccessControlRecord[]): any
        • Parameters

          • value: AccessControlRecord
          • index: number
          • array: AccessControlRecord[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns AccessControlRecord[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): AccessControlRecord | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: AccessControlRecord

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: AccessControlRecord, index: number, obj: AccessControlRecord[]): boolean
        • Parameters

          • this: void
          • value: AccessControlRecord
          • index: number
          • obj: AccessControlRecord[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: AccessControlRecord, index: number, obj: AccessControlRecord[]): boolean
        • Parameters

          • value: AccessControlRecord
          • index: number
          • obj: AccessControlRecord[]

          Returns boolean

    • Optional thisArg: any

    Returns AccessControlRecord | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: AccessControlRecord, index: number, obj: AccessControlRecord[]): boolean
        • Parameters

          • value: AccessControlRecord
          • index: number
          • obj: AccessControlRecord[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: AccessControlRecord, index: number, array: AccessControlRecord[]): void
        • Parameters

          • value: AccessControlRecord
          • index: number
          • array: AccessControlRecord[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: AccessControlRecord, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: AccessControlRecord

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: AccessControlRecord, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: AccessControlRecord

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: AccessControlRecord, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: AccessControlRecord

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: AccessControlRecord, index: number, array: AccessControlRecord[]): U
        • Parameters

          • value: AccessControlRecord
          • index: number
          • array: AccessControlRecord[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): AccessControlRecord | undefined
  • Removes the last element from an array and returns it.

    Returns AccessControlRecord | undefined

push

  • push(...items: AccessControlRecord[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: AccessControlRecord[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): AccessControlRecord
  • reduce(callbackfn: function, initialValue: AccessControlRecord): AccessControlRecord
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: AccessControlRecord, currentValue: AccessControlRecord, currentIndex: number, array: AccessControlRecord[]): AccessControlRecord
        • Parameters

          • previousValue: AccessControlRecord
          • currentValue: AccessControlRecord
          • currentIndex: number
          • array: AccessControlRecord[]

          Returns AccessControlRecord

    Returns AccessControlRecord

  • Parameters

    • callbackfn: function
        • (previousValue: AccessControlRecord, currentValue: AccessControlRecord, currentIndex: number, array: AccessControlRecord[]): AccessControlRecord
        • Parameters

          • previousValue: AccessControlRecord
          • currentValue: AccessControlRecord
          • currentIndex: number
          • array: AccessControlRecord[]

          Returns AccessControlRecord

    • initialValue: AccessControlRecord

    Returns AccessControlRecord

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: AccessControlRecord, currentIndex: number, array: AccessControlRecord[]): U
        • Parameters

          • previousValue: U
          • currentValue: AccessControlRecord
          • currentIndex: number
          • array: AccessControlRecord[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): AccessControlRecord
  • reduceRight(callbackfn: function, initialValue: AccessControlRecord): AccessControlRecord
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: AccessControlRecord, currentValue: AccessControlRecord, currentIndex: number, array: AccessControlRecord[]): AccessControlRecord
        • Parameters

          • previousValue: AccessControlRecord
          • currentValue: AccessControlRecord
          • currentIndex: number
          • array: AccessControlRecord[]

          Returns AccessControlRecord

    Returns AccessControlRecord

  • Parameters

    • callbackfn: function
        • (previousValue: AccessControlRecord, currentValue: AccessControlRecord, currentIndex: number, array: AccessControlRecord[]): AccessControlRecord
        • Parameters

          • previousValue: AccessControlRecord
          • currentValue: AccessControlRecord
          • currentIndex: number
          • array: AccessControlRecord[]

          Returns AccessControlRecord

    • initialValue: AccessControlRecord

    Returns AccessControlRecord

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: AccessControlRecord, currentIndex: number, array: AccessControlRecord[]): U
        • Parameters

          • previousValue: U
          • currentValue: AccessControlRecord
          • currentIndex: number
          • array: AccessControlRecord[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): AccessControlRecord[]
  • Reverses the elements in an Array.

    Returns AccessControlRecord[]

shift

  • shift(): AccessControlRecord | undefined
  • Removes the first element from an array and returns it.

    Returns AccessControlRecord | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): AccessControlRecord[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns AccessControlRecord[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: AccessControlRecord, index: number, array: AccessControlRecord[]): boolean
        • Parameters

          • value: AccessControlRecord
          • index: number
          • array: AccessControlRecord[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): AccessControlRecord[]
  • splice(start: number, deleteCount: number, ...items: AccessControlRecord[]): AccessControlRecord[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns AccessControlRecord[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: AccessControlRecord[]

      Elements to insert into the array in place of the deleted elements.

    Returns AccessControlRecord[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: AccessControlRecord[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: AccessControlRecord[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<AccessControlRecord>
  • Returns an iterable of values in the array

    Returns IterableIterator<AccessControlRecord>

type

type: object

className

className: string = "AccessControlRecordList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AccessControlRecord"

name

name: "Composite" = "Composite"

Const AcsConfiguration

AcsConfiguration: object
interface

An interface representing AcsConfiguration. The ACS configuration.

namespace

namespace: string
member

{string} namespace The namespace.

realm

realm: string
member

{string} realm The realm.

serializedName

serializedName: string = "AcsConfiguration"

serviceUrl

serviceUrl: string
member

{string} serviceUrl The service URL.

type

type: object

className

className: string = "AcsConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

namespace

namespace: object

required

required: true = true

serializedName

serializedName: string = "namespace"

type

type: object

name

name: "String" = "String"

realm

realm: object

required

required: true = true

serializedName

serializedName: string = "realm"

type

type: object

name

name: "String" = "String"

serviceUrl

serviceUrl: object

required

required: true = true

serializedName

serializedName: string = "serviceUrl"

type

type: object

name

name: "String" = "String"

Const Alert

Alert: object
interface

An interface representing Alert. The alert.

extends

BaseModel

alertType

alertType: string
member

{string} alertType The type of the alert

appearedAtSourceTime

appearedAtSourceTime: Date
member

{Date} appearedAtSourceTime The source time at which the alert was raised

appearedAtTime

appearedAtTime: Date
member

{Date} appearedAtTime The UTC time at which the alert was raised

Optional clearedAtSourceTime

clearedAtSourceTime: Date
member

{Date} [clearedAtSourceTime] The source time at which the alert was cleared

Optional clearedAtTime

clearedAtTime: Date
member

{Date} [clearedAtTime] The UTC time at which the alert was cleared

Optional detailedInformation

detailedInformation: undefined | object
member

{{ [propertyName: string]: string }} [detailedInformation] More details about the alert

Optional errorDetails

errorDetails: AlertErrorDetails
member

{AlertErrorDetails} [errorDetails] The details of the error for which the alert was raised

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional recommendation

recommendation: undefined | string
member

{string} [recommendation] The recommended action for the issue raised in the alert

Optional resolutionReason

resolutionReason: undefined | string
member

{string} [resolutionReason] The reason for resolving the alert

scope

scope: AlertScope
member

{AlertScope} scope The scope of the alert. Possible values include: 'Resource', 'Device'

serializedName

serializedName: string = "Alert"

severity

severity: AlertSeverity
member

{AlertSeverity} severity The severity of the alert. Possible values include: 'Informational', 'Warning', 'Critical'

source

source: AlertSource
member

{AlertSource} source The source at which the alert was raised

status

status: AlertStatus
member

{AlertStatus} status The current status of the alert. Possible values include: 'Active', 'Cleared'

title

title: string
member

{string} title The title of the alert

type

type: object

className

className: string = "Alert"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

alertType

alertType: object

required

required: true = true

serializedName

serializedName: string = "properties.alertType"

type

type: object

name

name: "String" = "String"

appearedAtSourceTime

appearedAtSourceTime: object

required

required: true = true

serializedName

serializedName: string = "properties.appearedAtSourceTime"

type

type: object

name

name: "DateTime" = "DateTime"

appearedAtTime

appearedAtTime: object

required

required: true = true

serializedName

serializedName: string = "properties.appearedAtTime"

type

type: object

name

name: "DateTime" = "DateTime"

clearedAtSourceTime

clearedAtSourceTime: object

serializedName

serializedName: string = "properties.clearedAtSourceTime"

type

type: object

name

name: "DateTime" = "DateTime"

clearedAtTime

clearedAtTime: object

serializedName

serializedName: string = "properties.clearedAtTime"

type

type: object

name

name: "DateTime" = "DateTime"

detailedInformation

detailedInformation: object

serializedName

serializedName: string = "properties.detailedInformation"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

errorDetails

errorDetails: object

serializedName

serializedName: string = "properties.errorDetails"

type

type: object

className

className: string = "AlertErrorDetails"

name

name: "Composite" = "Composite"

recommendation

recommendation: object

serializedName

serializedName: string = "properties.recommendation"

type

type: object

name

name: "String" = "String"

resolutionReason

resolutionReason: object

serializedName

serializedName: string = "properties.resolutionReason"

type

type: object

name

name: "String" = "String"

scope

scope: object

required

required: true = true

serializedName

serializedName: string = "properties.scope"

type

type: object

allowedValues

allowedValues: string[] = ["Resource","Device"]

name

name: "Enum" = "Enum"

severity

severity: object

required

required: true = true

serializedName

serializedName: string = "properties.severity"

type

type: object

allowedValues

allowedValues: string[] = ["Informational","Warning","Critical"]

name

name: "Enum" = "Enum"

source

source: object

required

required: true = true

serializedName

serializedName: string = "properties.source"

type

type: object

className

className: string = "AlertSource"

name

name: "Composite" = "Composite"

status

status: object

required

required: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

allowedValues

allowedValues: string[] = ["Active","Cleared"]

name

name: "Enum" = "Enum"

title

title: object

required

required: true = true

serializedName

serializedName: string = "properties.title"

type

type: object

name

name: "String" = "String"

Const AlertErrorDetails

AlertErrorDetails: object
interface

An interface representing AlertErrorDetails. The details of the error for which the alert was raised

Optional errorCode

errorCode: undefined | string
member

{string} [errorCode] The error code

Optional errorMessage

errorMessage: undefined | string
member

{string} [errorMessage] The error message

Optional occurences

occurences: undefined | number
member

{number} [occurences] The number of occurences

serializedName

serializedName: string = "AlertErrorDetails"

type

type: object

className

className: string = "AlertErrorDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

errorCode

errorCode: object

serializedName

serializedName: string = "errorCode"

type

type: object

name

name: "String" = "String"

errorMessage

errorMessage: object

serializedName

serializedName: string = "errorMessage"

type

type: object

name

name: "String" = "String"

occurences

occurences: object

serializedName

serializedName: string = "occurences"

type

type: object

name

name: "Number" = "Number"

Const AlertFilter

AlertFilter: object
interface

An interface representing AlertFilter. The OData filters to be used for Alert

Optional appearedOnTime

appearedOnTime: Date
member

{Date} [appearedOnTime] Specifies the appeared time (in UTC) of the alerts to be filtered. Only 'Greater-Than' and 'Lesser-Than' operators are supported for this property.

serializedName

serializedName: string = "AlertFilter"

Optional severity

severity: AlertSeverity
member

{AlertSeverity} [severity] Specifies the severity of the alerts to be filtered. Only 'Equality' operator is supported for this property. Possible values include: 'Informational', 'Warning', 'Critical'

Optional sourceName

sourceName: undefined | string
member

{string} [sourceName] Specifies the source name of the alerts to be filtered. Only 'Equality' operator is supported for this property.

Optional sourceType

sourceType: AlertSourceType
member

{AlertSourceType} [sourceType] Specifies the source type of the alerts to be filtered. Only 'Equality' operator is supported for this property. Possible values include: 'Resource', 'Device'

Optional status

status: AlertStatus
member

{AlertStatus} [status] Specifies the status of the alerts to be filtered. Only 'Equality' operator is supported for this property. Possible values include: 'Active', 'Cleared'

type

type: object

className

className: string = "AlertFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

appearedOnTime

appearedOnTime: object

serializedName

serializedName: string = "appearedOnTime"

type

type: object

name

name: "DateTime" = "DateTime"

severity

severity: object

serializedName

serializedName: string = "severity"

type

type: object

allowedValues

allowedValues: string[] = ["Informational","Warning","Critical"]

name

name: "Enum" = "Enum"

sourceName

sourceName: object

serializedName

serializedName: string = "sourceName"

type

type: object

name

name: "String" = "String"

sourceType

sourceType: object

serializedName

serializedName: string = "sourceType"

type

type: object

allowedValues

allowedValues: string[] = ["Resource","Device"]

name

name: "Enum" = "Enum"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["Active","Cleared"]

name

name: "Enum" = "Enum"

Const AlertList

AlertList: object
interface

An interface representing the AlertList. The collection of alerts.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The URI of the next page of alerts.

serializedName

serializedName: string = "AlertList"

__@iterator

  • __@iterator(): IterableIterator<Alert>
  • Iterator

    Returns IterableIterator<Alert>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Alert>[]): Alert[]
  • concat(...items: (T | ConcatArray<T>)[]): Alert[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Alert>[]

      Additional items to add to the end of array1.

    Returns Alert[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Alert[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Alert]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Alert]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Alert, index: number, array: Alert[]): boolean
        • Parameters

          • value: Alert
          • index: number
          • array: Alert[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Alert, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Alert

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Alert[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Alert

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Alert, index: number, array: Alert[]): boolean
        • Parameters

          • value: Alert
          • index: number
          • array: Alert[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Alert, index: number, array: Alert[]): any
        • Parameters

          • value: Alert
          • index: number
          • array: Alert[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Alert[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Alert | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Alert

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Alert, index: number, obj: Alert[]): boolean
        • Parameters

          • this: void
          • value: Alert
          • index: number
          • obj: Alert[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Alert, index: number, obj: Alert[]): boolean
        • Parameters

          • value: Alert
          • index: number
          • obj: Alert[]

          Returns boolean

    • Optional thisArg: any

    Returns Alert | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Alert, index: number, obj: Alert[]): boolean
        • Parameters

          • value: Alert
          • index: number
          • obj: Alert[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Alert, index: number, array: Alert[]): void
        • Parameters

          • value: Alert
          • index: number
          • array: Alert[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Alert, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Alert

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Alert, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Alert

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Alert, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Alert

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Alert, index: number, array: Alert[]): U
        • Parameters

          • value: Alert
          • index: number
          • array: Alert[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Alert | undefined
  • Removes the last element from an array and returns it.

    Returns Alert | undefined

push

  • push(...items: Alert[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Alert[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Alert
  • reduce(callbackfn: function, initialValue: Alert): Alert
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Alert, currentValue: Alert, currentIndex: number, array: Alert[]): Alert
        • Parameters

          • previousValue: Alert
          • currentValue: Alert
          • currentIndex: number
          • array: Alert[]

          Returns Alert

    Returns Alert

  • Parameters

    • callbackfn: function
        • (previousValue: Alert, currentValue: Alert, currentIndex: number, array: Alert[]): Alert
        • Parameters

          • previousValue: Alert
          • currentValue: Alert
          • currentIndex: number
          • array: Alert[]

          Returns Alert

    • initialValue: Alert

    Returns Alert

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Alert, currentIndex: number, array: Alert[]): U
        • Parameters

          • previousValue: U
          • currentValue: Alert
          • currentIndex: number
          • array: Alert[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Alert
  • reduceRight(callbackfn: function, initialValue: Alert): Alert
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Alert, currentValue: Alert, currentIndex: number, array: Alert[]): Alert
        • Parameters

          • previousValue: Alert
          • currentValue: Alert
          • currentIndex: number
          • array: Alert[]

          Returns Alert

    Returns Alert

  • Parameters

    • callbackfn: function
        • (previousValue: Alert, currentValue: Alert, currentIndex: number, array: Alert[]): Alert
        • Parameters

          • previousValue: Alert
          • currentValue: Alert
          • currentIndex: number
          • array: Alert[]

          Returns Alert

    • initialValue: Alert

    Returns Alert

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Alert, currentIndex: number, array: Alert[]): U
        • Parameters

          • previousValue: U
          • currentValue: Alert
          • currentIndex: number
          • array: Alert[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Alert[]
  • Reverses the elements in an Array.

    Returns Alert[]

shift

  • shift(): Alert | undefined
  • Removes the first element from an array and returns it.

    Returns Alert | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Alert[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Alert[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Alert, index: number, array: Alert[]): boolean
        • Parameters

          • value: Alert
          • index: number
          • array: Alert[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Alert[]
  • splice(start: number, deleteCount: number, ...items: Alert[]): Alert[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Alert[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Alert[]

      Elements to insert into the array in place of the deleted elements.

    Returns Alert[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Alert[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Alert[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Alert>
  • Returns an iterable of values in the array

    Returns IterableIterator<Alert>

type

type: object

className

className: string = "AlertList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Alert"

name

name: "Composite" = "Composite"

Const AlertSettings

AlertSettings: object
interface

An interface representing AlertSettings. The alert settings.

extends

BaseModel

Optional additionalRecipientEmailList

additionalRecipientEmailList: string[]
member

{string[]} [additionalRecipientEmailList] The alert notification email list.

Optional alertNotificationCulture

alertNotificationCulture: undefined | string
member

{string} [alertNotificationCulture] The alert notification culture.

emailNotification

emailNotification: AlertEmailNotificationStatus
member

{AlertEmailNotificationStatus} emailNotification Indicates whether email notification enabled or not. Possible values include: 'Enabled', 'Disabled'

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional notificationToServiceOwners

notificationToServiceOwners: AlertEmailNotificationStatus
member

{AlertEmailNotificationStatus} [notificationToServiceOwners] The value indicating whether alert notification enabled for admin or not. Possible values include: 'Enabled', 'Disabled'

serializedName

serializedName: string = "AlertSettings"

type

type: object

className

className: string = "AlertSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

additionalRecipientEmailList

additionalRecipientEmailList: object

serializedName

serializedName: string = "properties.additionalRecipientEmailList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

alertNotificationCulture

alertNotificationCulture: object

serializedName

serializedName: string = "properties.alertNotificationCulture"

type

type: object

name

name: "String" = "String"

emailNotification

emailNotification: object

required

required: true = true

serializedName

serializedName: string = "properties.emailNotification"

type

type: object

allowedValues

allowedValues: string[] = ["Enabled","Disabled"]

name

name: "Enum" = "Enum"

notificationToServiceOwners

notificationToServiceOwners: object

serializedName

serializedName: string = "properties.notificationToServiceOwners"

type

type: object

allowedValues

allowedValues: string[] = ["Enabled","Disabled"]

name

name: "Enum" = "Enum"

Const AlertSource

AlertSource: object
interface

An interface representing AlertSource. The source details at which the alert was raised

Optional alertSourceType

alertSourceType: AlertSourceType
member

{AlertSourceType} [alertSourceType] The source type of the alert. Possible values include: 'Resource', 'Device'

Optional name

name: undefined | string
member

{string} [name] The name of the source

serializedName

serializedName: string = "AlertSource"

Optional timeZone

timeZone: undefined | string
member

{string} [timeZone] The time zone of the source

type

type: object

className

className: string = "AlertSource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

alertSourceType

alertSourceType: object

serializedName

serializedName: string = "alertSourceType"

type

type: object

allowedValues

allowedValues: string[] = ["Resource","Device"]

name

name: "Enum" = "Enum"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

timeZone

timeZone: object

serializedName

serializedName: string = "timeZone"

type

type: object

name

name: "String" = "String"

Const AsymmetricEncryptedSecret

AsymmetricEncryptedSecret: object
interface

An interface representing AsymmetricEncryptedSecret. Represent the secrets intended for encryption with asymmetric key pair.

encryptionAlgorithm

encryptionAlgorithm: EncryptionAlgorithm
member

{EncryptionAlgorithm} encryptionAlgorithm The algorithm used to encrypt "Value". Possible values include: 'None', 'AES256', 'RSAES_PKCS1_v_1_5'

Optional encryptionCertThumbprint

encryptionCertThumbprint: undefined | string
member

{string} [encryptionCertThumbprint] Thumbprint certificate that was used to encrypt "Value". If the value in unencrypted, it will be null.

serializedName

serializedName: string = "AsymmetricEncryptedSecret"

value

value: string
member

{string} value The value of the secret.

type

type: object

className

className: string = "AsymmetricEncryptedSecret"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

encryptionAlgorithm

encryptionAlgorithm: object

required

required: true = true

serializedName

serializedName: string = "encryptionAlgorithm"

type

type: object

allowedValues

allowedValues: string[] = ["None","AES256","RSAES_PKCS1_v_1_5"]

name

name: "Enum" = "Enum"

encryptionCertThumbprint

encryptionCertThumbprint: object

serializedName

serializedName: string = "encryptionCertThumbprint"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const AvailableProviderOperation

AvailableProviderOperation: object
interface

An interface representing AvailableProviderOperation. Represents available provider operation.

Optional display

member

{AvailableProviderOperationDisplay} [display] Contains the localized display information for this particular operation/action.

Optional name

name: undefined | string
member

{string} [name] The name of the operation being performed on a particular object. Name format: "{resourceProviderNamespace}/{resourceType}/{read|write|delete|action}". Eg. Microsoft.StorSimple/managers/devices/volumeContainers/read, Microsoft.StorSimple/managers/devices/alerts/clearAlerts/action

Optional origin

origin: undefined | string
member

{string} [origin] The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. Default value is "user,system"

Optional properties

properties: any
member

{any} [properties] Reserved for future use.

serializedName

serializedName: string = "AvailableProviderOperation"

type

type: object

className

className: string = "AvailableProviderOperation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

display

display: object

serializedName

serializedName: string = "display"

type

type: object

className

className: string = "AvailableProviderOperationDisplay"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

origin

origin: object

serializedName

serializedName: string = "origin"

type

type: object

name

name: "String" = "String"

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

name

name: "Object" = "Object"

Const AvailableProviderOperationDisplay

AvailableProviderOperationDisplay: object
interface

An interface representing AvailableProviderOperationDisplay. Contains the localized display information for this particular operation/action. These value will be used by several clients for (a) custom role definitions for RBAC, (b) complex query filters for the event service and (c) audit history/records for management operations.

Optional description

description: undefined | string
member

{string} [description] The localized friendly description for the operation, as it should be shown to the user. It should be thorough, yet concise - it will be used in tool tips and detailed views.

Optional operation

operation: undefined | string
member

{string} [operation] The localized friendly name for the operation, as it should be shown to the user. It should be concise (to fit in drop downs) but clear (i.e. self-documenting). It should use Title Casing and include the entity/resource to which it applies.

Optional provider

provider: undefined | string
member

{string} [provider] The localized friendly form of the resource provider name - it is expected to also include the publisher/company responsible. It should use Title Casing and begin with 'Microsoft' for 1st party services.

Optional resource

resource: undefined | string
member

{string} [resource] The localized friendly form of the resource type related to this action/operation - it should match the public documentation for the resource provider. It should use Title Casing - for examples, please refer to the 'name' section.

serializedName

serializedName: string = "AvailableProviderOperationDisplay"

type

type: object

className

className: string = "AvailableProviderOperationDisplay"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

operation

operation: object

serializedName

serializedName: string = "operation"

type

type: object

name

name: "String" = "String"

provider

provider: object

serializedName

serializedName: string = "provider"

type

type: object

name

name: "String" = "String"

resource

resource: object

serializedName

serializedName: string = "resource"

type

type: object

name

name: "String" = "String"

Const AvailableProviderOperationList

AvailableProviderOperationList: object
interface

An interface representing the AvailableProviderOperationList. List of available provider operations.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The NextLink.

serializedName

serializedName: string = "AvailableProviderOperationList"

__@iterator

  • __@iterator(): IterableIterator<AvailableProviderOperation>
  • Iterator

    Returns IterableIterator<AvailableProviderOperation>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<AvailableProviderOperation>[]): AvailableProviderOperation[]
  • concat(...items: (T | ConcatArray<T>)[]): AvailableProviderOperation[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<AvailableProviderOperation>[]

      Additional items to add to the end of array1.

    Returns AvailableProviderOperation[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns AvailableProviderOperation[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, AvailableProviderOperation]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, AvailableProviderOperation]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: AvailableProviderOperation, index: number, array: AvailableProviderOperation[]): boolean
        • Parameters

          • value: AvailableProviderOperation
          • index: number
          • array: AvailableProviderOperation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: AvailableProviderOperation, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: AvailableProviderOperation

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): AvailableProviderOperation[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: AvailableProviderOperation

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: AvailableProviderOperation, index: number, array: AvailableProviderOperation[]): boolean
        • Parameters

          • value: AvailableProviderOperation
          • index: number
          • array: AvailableProviderOperation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: AvailableProviderOperation, index: number, array: AvailableProviderOperation[]): any
        • Parameters

          • value: AvailableProviderOperation
          • index: number
          • array: AvailableProviderOperation[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns AvailableProviderOperation[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): AvailableProviderOperation | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: AvailableProviderOperation

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: AvailableProviderOperation, index: number, obj: AvailableProviderOperation[]): boolean
        • Parameters

          • this: void
          • value: AvailableProviderOperation
          • index: number
          • obj: AvailableProviderOperation[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: AvailableProviderOperation, index: number, obj: AvailableProviderOperation[]): boolean
        • Parameters

          • value: AvailableProviderOperation
          • index: number
          • obj: AvailableProviderOperation[]

          Returns boolean

    • Optional thisArg: any

    Returns AvailableProviderOperation | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: AvailableProviderOperation, index: number, obj: AvailableProviderOperation[]): boolean
        • Parameters

          • value: AvailableProviderOperation
          • index: number
          • obj: AvailableProviderOperation[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: AvailableProviderOperation, index: number, array: AvailableProviderOperation[]): void
        • Parameters

          • value: AvailableProviderOperation
          • index: number
          • array: AvailableProviderOperation[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: AvailableProviderOperation, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: AvailableProviderOperation

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: AvailableProviderOperation, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: AvailableProviderOperation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: AvailableProviderOperation, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: AvailableProviderOperation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: AvailableProviderOperation, index: number, array: AvailableProviderOperation[]): U
        • Parameters

          • value: AvailableProviderOperation
          • index: number
          • array: AvailableProviderOperation[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): AvailableProviderOperation | undefined
  • Removes the last element from an array and returns it.

    Returns AvailableProviderOperation | undefined

push

  • push(...items: AvailableProviderOperation[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: AvailableProviderOperation[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): AvailableProviderOperation
  • reduce(callbackfn: function, initialValue: AvailableProviderOperation): AvailableProviderOperation
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: AvailableProviderOperation, currentValue: AvailableProviderOperation, currentIndex: number, array: AvailableProviderOperation[]): AvailableProviderOperation
        • Parameters

          • previousValue: AvailableProviderOperation
          • currentValue: AvailableProviderOperation
          • currentIndex: number
          • array: AvailableProviderOperation[]

          Returns AvailableProviderOperation

    Returns AvailableProviderOperation

  • Parameters

    • callbackfn: function
        • (previousValue: AvailableProviderOperation, currentValue: AvailableProviderOperation, currentIndex: number, array: AvailableProviderOperation[]): AvailableProviderOperation
        • Parameters

          • previousValue: AvailableProviderOperation
          • currentValue: AvailableProviderOperation
          • currentIndex: number
          • array: AvailableProviderOperation[]

          Returns AvailableProviderOperation

    • initialValue: AvailableProviderOperation

    Returns AvailableProviderOperation

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: AvailableProviderOperation, currentIndex: number, array: AvailableProviderOperation[]): U
        • Parameters

          • previousValue: U
          • currentValue: AvailableProviderOperation
          • currentIndex: number
          • array: AvailableProviderOperation[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): AvailableProviderOperation
  • reduceRight(callbackfn: function, initialValue: AvailableProviderOperation): AvailableProviderOperation
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: AvailableProviderOperation, currentValue: AvailableProviderOperation, currentIndex: number, array: AvailableProviderOperation[]): AvailableProviderOperation
        • Parameters

          • previousValue: AvailableProviderOperation
          • currentValue: AvailableProviderOperation
          • currentIndex: number
          • array: AvailableProviderOperation[]

          Returns AvailableProviderOperation

    Returns AvailableProviderOperation

  • Parameters

    • callbackfn: function
        • (previousValue: AvailableProviderOperation, currentValue: AvailableProviderOperation, currentIndex: number, array: AvailableProviderOperation[]): AvailableProviderOperation
        • Parameters

          • previousValue: AvailableProviderOperation
          • currentValue: AvailableProviderOperation
          • currentIndex: number
          • array: AvailableProviderOperation[]

          Returns AvailableProviderOperation

    • initialValue: AvailableProviderOperation

    Returns AvailableProviderOperation

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: AvailableProviderOperation, currentIndex: number, array: AvailableProviderOperation[]): U
        • Parameters

          • previousValue: U
          • currentValue: AvailableProviderOperation
          • currentIndex: number
          • array: AvailableProviderOperation[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): AvailableProviderOperation[]
  • Reverses the elements in an Array.

    Returns AvailableProviderOperation[]

shift

  • shift(): AvailableProviderOperation | undefined
  • Removes the first element from an array and returns it.

    Returns AvailableProviderOperation | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): AvailableProviderOperation[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns AvailableProviderOperation[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: AvailableProviderOperation, index: number, array: AvailableProviderOperation[]): boolean
        • Parameters

          • value: AvailableProviderOperation
          • index: number
          • array: AvailableProviderOperation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): AvailableProviderOperation[]
  • splice(start: number, deleteCount: number, ...items: AvailableProviderOperation[]): AvailableProviderOperation[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns AvailableProviderOperation[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: AvailableProviderOperation[]

      Elements to insert into the array in place of the deleted elements.

    Returns AvailableProviderOperation[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: AvailableProviderOperation[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: AvailableProviderOperation[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<AvailableProviderOperation>
  • Returns an iterable of values in the array

    Returns IterableIterator<AvailableProviderOperation>

type

type: object

className

className: string = "AvailableProviderOperationList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AvailableProviderOperation"

name

name: "Composite" = "Composite"

Const Backup

Backup: object
interface

An interface representing Backup. The backup.

extends

BaseModel

Optional backupJobCreationType

backupJobCreationType: BackupJobCreationType
member

{BackupJobCreationType} [backupJobCreationType] The backup job creation type. Possible values include: 'Adhoc', 'BySchedule', 'BySSM'

Optional backupPolicyId

backupPolicyId: undefined | string
member

{string} [backupPolicyId] The path ID of the backup policy.

Optional backupType

backupType: BackupType
member

{BackupType} [backupType] The type of the backup. Possible values include: 'LocalSnapshot', 'CloudSnapshot'

createdOn

createdOn: Date
member

{Date} createdOn The time when the backup was created.

elements

elements: BackupElement[]
member

{BackupElement[]} elements The backup elements.

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Backup"

sizeInBytes

sizeInBytes: number
member

{number} sizeInBytes The backup size in bytes.

Optional ssmHostName

ssmHostName: undefined | string
member

{string} [ssmHostName] The StorSimple Snapshot Manager host name.

type

type: object

className

className: string = "Backup"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupJobCreationType

backupJobCreationType: object

serializedName

serializedName: string = "properties.backupJobCreationType"

type

type: object

allowedValues

allowedValues: string[] = ["Adhoc","BySchedule","BySSM"]

name

name: "Enum" = "Enum"

backupPolicyId

backupPolicyId: object

serializedName

serializedName: string = "properties.backupPolicyId"

type

type: object

name

name: "String" = "String"

backupType

backupType: object

serializedName

serializedName: string = "properties.backupType"

type

type: object

allowedValues

allowedValues: string[] = ["LocalSnapshot","CloudSnapshot"]

name

name: "Enum" = "Enum"

createdOn

createdOn: object

required

required: true = true

serializedName

serializedName: string = "properties.createdOn"

type

type: object

name

name: "DateTime" = "DateTime"

elements

elements: object

required

required: true = true

serializedName

serializedName: string = "properties.elements"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BackupElement"

name

name: "Composite" = "Composite"

sizeInBytes

sizeInBytes: object

required

required: true = true

serializedName

serializedName: string = "properties.sizeInBytes"

type

type: object

name

name: "Number" = "Number"

ssmHostName

ssmHostName: object

serializedName

serializedName: string = "properties.ssmHostName"

type

type: object

name

name: "String" = "String"

Const BackupElement

BackupElement: object
interface

An interface representing BackupElement. The backup element.

elementId

elementId: string
member

{string} elementId The path ID that uniquely identifies the backup element.

elementName

elementName: string
member

{string} elementName The name of the backup element.

elementType

elementType: string
member

{string} elementType The hierarchical type of the backup element.

serializedName

serializedName: string = "BackupElement"

sizeInBytes

sizeInBytes: number
member

{number} sizeInBytes The size in bytes.

volumeContainerId

volumeContainerId: string
member

{string} volumeContainerId The path ID of the volume container.

volumeName

volumeName: string
member

{string} volumeName The name of the volume.

Optional volumeType

volumeType: VolumeType
member

{VolumeType} [volumeType] The volume type. Possible values include: 'Tiered', 'Archival', 'LocallyPinned'

type

type: object

className

className: string = "BackupElement"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

elementId

elementId: object

required

required: true = true

serializedName

serializedName: string = "elementId"

type

type: object

name

name: "String" = "String"

elementName

elementName: object

required

required: true = true

serializedName

serializedName: string = "elementName"

type

type: object

name

name: "String" = "String"

elementType

elementType: object

required

required: true = true

serializedName

serializedName: string = "elementType"

type

type: object

name

name: "String" = "String"

sizeInBytes

sizeInBytes: object

required

required: true = true

serializedName

serializedName: string = "sizeInBytes"

type

type: object

name

name: "Number" = "Number"

volumeContainerId

volumeContainerId: object

required

required: true = true

serializedName

serializedName: string = "volumeContainerId"

type

type: object

name

name: "String" = "String"

volumeName

volumeName: object

required

required: true = true

serializedName

serializedName: string = "volumeName"

type

type: object

name

name: "String" = "String"

volumeType

volumeType: object

serializedName

serializedName: string = "volumeType"

type

type: object

allowedValues

allowedValues: string[] = ["Tiered","Archival","LocallyPinned"]

name

name: "Enum" = "Enum"

Const BackupFilter

BackupFilter: object
interface

An interface representing BackupFilter. The OData filters to be used for backups.

Optional backupPolicyId

backupPolicyId: undefined | string
member

{string} [backupPolicyId] Specifies the backupPolicyId of the backups to be filtered. Only 'Equality' operator is supported for this property.

Optional createdTime

createdTime: Date
member

{Date} [createdTime] Specifies the creation time of the backups to be filtered. Only 'Greater Than or Equal To' and 'Lesser Than or Equal To' operators are supported for this property.

serializedName

serializedName: string = "BackupFilter"

Optional volumeId

volumeId: undefined | string
member

{string} [volumeId] Specifies the volumeId of the backups to be filtered. Only 'Equality' operator is supported for this property.

type

type: object

className

className: string = "BackupFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupPolicyId

backupPolicyId: object

serializedName

serializedName: string = "backupPolicyId"

type

type: object

name

name: "String" = "String"

createdTime

createdTime: object

serializedName

serializedName: string = "createdTime"

type

type: object

name

name: "DateTime" = "DateTime"

volumeId

volumeId: object

serializedName

serializedName: string = "volumeId"

type

type: object

name

name: "String" = "String"

Const BackupList

BackupList: object
interface

An interface representing the BackupList. The collection of backups.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The NextLink.

serializedName

serializedName: string = "BackupList"

__@iterator

  • __@iterator(): IterableIterator<Backup>
  • Iterator

    Returns IterableIterator<Backup>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Backup>[]): Backup[]
  • concat(...items: (T | ConcatArray<T>)[]): Backup[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Backup>[]

      Additional items to add to the end of array1.

    Returns Backup[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Backup[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Backup]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Backup]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Backup, index: number, array: Backup[]): boolean
        • Parameters

          • value: Backup
          • index: number
          • array: Backup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Backup, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Backup

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Backup[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Backup

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Backup, index: number, array: Backup[]): boolean
        • Parameters

          • value: Backup
          • index: number
          • array: Backup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Backup, index: number, array: Backup[]): any
        • Parameters

          • value: Backup
          • index: number
          • array: Backup[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Backup[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Backup | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Backup

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Backup, index: number, obj: Backup[]): boolean
        • Parameters

          • this: void
          • value: Backup
          • index: number
          • obj: Backup[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Backup, index: number, obj: Backup[]): boolean
        • Parameters

          • value: Backup
          • index: number
          • obj: Backup[]

          Returns boolean

    • Optional thisArg: any

    Returns Backup | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Backup, index: number, obj: Backup[]): boolean
        • Parameters

          • value: Backup
          • index: number
          • obj: Backup[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Backup, index: number, array: Backup[]): void
        • Parameters

          • value: Backup
          • index: number
          • array: Backup[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Backup, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Backup

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Backup, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Backup

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Backup, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Backup

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Backup, index: number, array: Backup[]): U
        • Parameters

          • value: Backup
          • index: number
          • array: Backup[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Backup | undefined
  • Removes the last element from an array and returns it.

    Returns Backup | undefined

push

  • push(...items: Backup[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Backup[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Backup
  • reduce(callbackfn: function, initialValue: Backup): Backup
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Backup, currentValue: Backup, currentIndex: number, array: Backup[]): Backup
        • Parameters

          • previousValue: Backup
          • currentValue: Backup
          • currentIndex: number
          • array: Backup[]

          Returns Backup

    Returns Backup

  • Parameters

    • callbackfn: function
        • (previousValue: Backup, currentValue: Backup, currentIndex: number, array: Backup[]): Backup
        • Parameters

          • previousValue: Backup
          • currentValue: Backup
          • currentIndex: number
          • array: Backup[]

          Returns Backup

    • initialValue: Backup

    Returns Backup

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Backup, currentIndex: number, array: Backup[]): U
        • Parameters

          • previousValue: U
          • currentValue: Backup
          • currentIndex: number
          • array: Backup[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Backup
  • reduceRight(callbackfn: function, initialValue: Backup): Backup
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Backup, currentValue: Backup, currentIndex: number, array: Backup[]): Backup
        • Parameters

          • previousValue: Backup
          • currentValue: Backup
          • currentIndex: number
          • array: Backup[]

          Returns Backup

    Returns Backup

  • Parameters

    • callbackfn: function
        • (previousValue: Backup, currentValue: Backup, currentIndex: number, array: Backup[]): Backup
        • Parameters

          • previousValue: Backup
          • currentValue: Backup
          • currentIndex: number
          • array: Backup[]

          Returns Backup

    • initialValue: Backup

    Returns Backup

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Backup, currentIndex: number, array: Backup[]): U
        • Parameters

          • previousValue: U
          • currentValue: Backup
          • currentIndex: number
          • array: Backup[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Backup[]
  • Reverses the elements in an Array.

    Returns Backup[]

shift

  • shift(): Backup | undefined
  • Removes the first element from an array and returns it.

    Returns Backup | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Backup[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Backup[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Backup, index: number, array: Backup[]): boolean
        • Parameters

          • value: Backup
          • index: number
          • array: Backup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Backup[]
  • splice(start: number, deleteCount: number, ...items: Backup[]): Backup[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Backup[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Backup[]

      Elements to insert into the array in place of the deleted elements.

    Returns Backup[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Backup[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Backup[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Backup>
  • Returns an iterable of values in the array

    Returns IterableIterator<Backup>

type

type: object

className

className: string = "BackupList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Backup"

name

name: "Composite" = "Composite"

Const BackupPolicy

BackupPolicy: object
interface

An interface representing BackupPolicy. The backup policy.

extends

BaseModel

Optional backupPolicyCreationType

backupPolicyCreationType: BackupPolicyCreationType
member

{BackupPolicyCreationType} [backupPolicyCreationType] The backup policy creation type. Indicates whether this was created through SaaS or through StorSimple Snapshot Manager. Possible values include: 'BySaaS', 'BySSM' NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

Optional lastBackupTime

lastBackupTime: Date
member

{Date} [lastBackupTime] The time of the last backup for the backup policy. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nextBackupTime

nextBackupTime: Date
member

{Date} [nextBackupTime] The time of the next backup for the backup policy. NOTE: This property will not be serialized. It can only be populated by the server.

Optional scheduledBackupStatus

scheduledBackupStatus: ScheduledBackupStatus
member

{ScheduledBackupStatus} [scheduledBackupStatus] Indicates whether atleast one of the schedules in the backup policy is active or not. Possible values include: 'Disabled', 'Enabled' NOTE: This property will not be serialized. It can only be populated by the server.

Optional schedulesCount

schedulesCount: undefined | number
member

{number} [schedulesCount] The count of schedules the backup policy contains. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "BackupPolicy"

Optional ssmHostName

ssmHostName: undefined | string
member

{string} [ssmHostName] If the backup policy was created by StorSimple Snapshot Manager, then this field indicates the hostname of the StorSimple Snapshot Manager. NOTE: This property will not be serialized. It can only be populated by the server.

volumeIds

volumeIds: string[]
member

{string[]} volumeIds The path IDs of the volumes which are part of the backup policy.

type

type: object

className

className: string = "BackupPolicy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupPolicyCreationType

backupPolicyCreationType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.backupPolicyCreationType"

type

type: object

allowedValues

allowedValues: string[] = ["BySaaS","BySSM"]

name

name: "Enum" = "Enum"

lastBackupTime

lastBackupTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastBackupTime"

type

type: object

name

name: "DateTime" = "DateTime"

nextBackupTime

nextBackupTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.nextBackupTime"

type

type: object

name

name: "DateTime" = "DateTime"

scheduledBackupStatus

scheduledBackupStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.scheduledBackupStatus"

type

type: object

allowedValues

allowedValues: string[] = ["Disabled","Enabled"]

name

name: "Enum" = "Enum"

schedulesCount

schedulesCount: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.schedulesCount"

type

type: object

name

name: "Number" = "Number"

ssmHostName

ssmHostName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.ssmHostName"

type

type: object

name

name: "String" = "String"

volumeIds

volumeIds: object

required

required: true = true

serializedName

serializedName: string = "properties.volumeIds"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const BackupPolicyList

BackupPolicyList: object
interface

An interface representing the BackupPolicyList. The collection of backup policies.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "BackupPolicyList"

__@iterator

  • __@iterator(): IterableIterator<BackupPolicy>
  • Iterator

    Returns IterableIterator<BackupPolicy>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<BackupPolicy>[]): BackupPolicy[]
  • concat(...items: (T | ConcatArray<T>)[]): BackupPolicy[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<BackupPolicy>[]

      Additional items to add to the end of array1.

    Returns BackupPolicy[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns BackupPolicy[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, BackupPolicy]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, BackupPolicy]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: BackupPolicy, index: number, array: BackupPolicy[]): boolean
        • Parameters

          • value: BackupPolicy
          • index: number
          • array: BackupPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: BackupPolicy, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: BackupPolicy

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): BackupPolicy[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: BackupPolicy

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BackupPolicy, index: number, array: BackupPolicy[]): boolean
        • Parameters

          • value: BackupPolicy
          • index: number
          • array: BackupPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BackupPolicy, index: number, array: BackupPolicy[]): any
        • Parameters

          • value: BackupPolicy
          • index: number
          • array: BackupPolicy[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns BackupPolicy[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): BackupPolicy | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: BackupPolicy

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: BackupPolicy, index: number, obj: BackupPolicy[]): boolean
        • Parameters

          • this: void
          • value: BackupPolicy
          • index: number
          • obj: BackupPolicy[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: BackupPolicy, index: number, obj: BackupPolicy[]): boolean
        • Parameters

          • value: BackupPolicy
          • index: number
          • obj: BackupPolicy[]

          Returns boolean

    • Optional thisArg: any

    Returns BackupPolicy | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: BackupPolicy, index: number, obj: BackupPolicy[]): boolean
        • Parameters

          • value: BackupPolicy
          • index: number
          • obj: BackupPolicy[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: BackupPolicy, index: number, array: BackupPolicy[]): void
        • Parameters

          • value: BackupPolicy
          • index: number
          • array: BackupPolicy[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: BackupPolicy, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: BackupPolicy

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: BackupPolicy, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: BackupPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: BackupPolicy, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: BackupPolicy

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: BackupPolicy, index: number, array: BackupPolicy[]): U
        • Parameters

          • value: BackupPolicy
          • index: number
          • array: BackupPolicy[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): BackupPolicy | undefined
  • Removes the last element from an array and returns it.

    Returns BackupPolicy | undefined

push

  • push(...items: BackupPolicy[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: BackupPolicy[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): BackupPolicy
  • reduce(callbackfn: function, initialValue: BackupPolicy): BackupPolicy
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: BackupPolicy, currentValue: BackupPolicy, currentIndex: number, array: BackupPolicy[]): BackupPolicy
        • Parameters

          • previousValue: BackupPolicy
          • currentValue: BackupPolicy
          • currentIndex: number
          • array: BackupPolicy[]

          Returns BackupPolicy

    Returns BackupPolicy

  • Parameters

    • callbackfn: function
        • (previousValue: BackupPolicy, currentValue: BackupPolicy, currentIndex: number, array: BackupPolicy[]): BackupPolicy
        • Parameters

          • previousValue: BackupPolicy
          • currentValue: BackupPolicy
          • currentIndex: number
          • array: BackupPolicy[]

          Returns BackupPolicy

    • initialValue: BackupPolicy

    Returns BackupPolicy

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BackupPolicy, currentIndex: number, array: BackupPolicy[]): U
        • Parameters

          • previousValue: U
          • currentValue: BackupPolicy
          • currentIndex: number
          • array: BackupPolicy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): BackupPolicy
  • reduceRight(callbackfn: function, initialValue: BackupPolicy): BackupPolicy
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: BackupPolicy, currentValue: BackupPolicy, currentIndex: number, array: BackupPolicy[]): BackupPolicy
        • Parameters

          • previousValue: BackupPolicy
          • currentValue: BackupPolicy
          • currentIndex: number
          • array: BackupPolicy[]

          Returns BackupPolicy

    Returns BackupPolicy

  • Parameters

    • callbackfn: function
        • (previousValue: BackupPolicy, currentValue: BackupPolicy, currentIndex: number, array: BackupPolicy[]): BackupPolicy
        • Parameters

          • previousValue: BackupPolicy
          • currentValue: BackupPolicy
          • currentIndex: number
          • array: BackupPolicy[]

          Returns BackupPolicy

    • initialValue: BackupPolicy

    Returns BackupPolicy

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BackupPolicy, currentIndex: number, array: BackupPolicy[]): U
        • Parameters

          • previousValue: U
          • currentValue: BackupPolicy
          • currentIndex: number
          • array: BackupPolicy[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): BackupPolicy[]
  • Reverses the elements in an Array.

    Returns BackupPolicy[]

shift

  • shift(): BackupPolicy | undefined
  • Removes the first element from an array and returns it.

    Returns BackupPolicy | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): BackupPolicy[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns BackupPolicy[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: BackupPolicy, index: number, array: BackupPolicy[]): boolean
        • Parameters

          • value: BackupPolicy
          • index: number
          • array: BackupPolicy[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): BackupPolicy[]
  • splice(start: number, deleteCount: number, ...items: BackupPolicy[]): BackupPolicy[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns BackupPolicy[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: BackupPolicy[]

      Elements to insert into the array in place of the deleted elements.

    Returns BackupPolicy[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: BackupPolicy[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: BackupPolicy[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<BackupPolicy>
  • Returns an iterable of values in the array

    Returns IterableIterator<BackupPolicy>

type

type: object

className

className: string = "BackupPolicyList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BackupPolicy"

name

name: "Composite" = "Composite"

Const BackupSchedule

BackupSchedule: object
interface

An interface representing BackupSchedule. The backup schedule.

extends

BaseModel

backupType

backupType: BackupType
member

{BackupType} backupType The type of backup which needs to be taken. Possible values include: 'LocalSnapshot', 'CloudSnapshot'

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

Optional lastSuccessfulRun

lastSuccessfulRun: Date
member

{Date} [lastSuccessfulRun] The last successful backup run which was triggered for the schedule. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

retentionCount

retentionCount: number
member

{number} retentionCount The number of backups to be retained.

scheduleRecurrence

scheduleRecurrence: ScheduleRecurrence
member

{ScheduleRecurrence} scheduleRecurrence The schedule recurrence.

scheduleStatus

scheduleStatus: ScheduleStatus
member

{ScheduleStatus} scheduleStatus The schedule status. Possible values include: 'Enabled', 'Disabled'

serializedName

serializedName: string = "BackupSchedule"

startTime

startTime: Date
member

{Date} startTime The start time of the schedule.

type

type: object

className

className: string = "BackupSchedule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupType

backupType: object

required

required: true = true

serializedName

serializedName: string = "properties.backupType"

type

type: object

allowedValues

allowedValues: string[] = ["LocalSnapshot","CloudSnapshot"]

name

name: "Enum" = "Enum"

lastSuccessfulRun

lastSuccessfulRun: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastSuccessfulRun"

type

type: object

name

name: "DateTime" = "DateTime"

retentionCount

retentionCount: object

required

required: true = true

serializedName

serializedName: string = "properties.retentionCount"

type

type: object

name

name: "Number" = "Number"

scheduleRecurrence

scheduleRecurrence: object

required

required: true = true

serializedName

serializedName: string = "properties.scheduleRecurrence"

type

type: object

className

className: string = "ScheduleRecurrence"

name

name: "Composite" = "Composite"

scheduleStatus

scheduleStatus: object

required

required: true = true

serializedName

serializedName: string = "properties.scheduleStatus"

type

type: object

allowedValues

allowedValues: string[] = ["Enabled","Disabled"]

name

name: "Enum" = "Enum"

startTime

startTime: object

required

required: true = true

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const BackupScheduleList

BackupScheduleList: object
interface

An interface representing the BackupScheduleList. The backup schedule list.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "BackupScheduleList"

__@iterator

  • __@iterator(): IterableIterator<BackupSchedule>
  • Iterator

    Returns IterableIterator<BackupSchedule>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<BackupSchedule>[]): BackupSchedule[]
  • concat(...items: (T | ConcatArray<T>)[]): BackupSchedule[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<BackupSchedule>[]

      Additional items to add to the end of array1.

    Returns BackupSchedule[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns BackupSchedule[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, BackupSchedule]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, BackupSchedule]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: BackupSchedule, index: number, array: BackupSchedule[]): boolean
        • Parameters

          • value: BackupSchedule
          • index: number
          • array: BackupSchedule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: BackupSchedule, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: BackupSchedule

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): BackupSchedule[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: BackupSchedule

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BackupSchedule, index: number, array: BackupSchedule[]): boolean
        • Parameters

          • value: BackupSchedule
          • index: number
          • array: BackupSchedule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BackupSchedule, index: number, array: BackupSchedule[]): any
        • Parameters

          • value: BackupSchedule
          • index: number
          • array: BackupSchedule[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns BackupSchedule[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): BackupSchedule | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: BackupSchedule

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: BackupSchedule, index: number, obj: BackupSchedule[]): boolean
        • Parameters

          • this: void
          • value: BackupSchedule
          • index: number
          • obj: BackupSchedule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: BackupSchedule, index: number, obj: BackupSchedule[]): boolean
        • Parameters

          • value: BackupSchedule
          • index: number
          • obj: BackupSchedule[]

          Returns boolean

    • Optional thisArg: any

    Returns BackupSchedule | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: BackupSchedule, index: number, obj: BackupSchedule[]): boolean
        • Parameters

          • value: BackupSchedule
          • index: number
          • obj: BackupSchedule[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: BackupSchedule, index: number, array: BackupSchedule[]): void
        • Parameters

          • value: BackupSchedule
          • index: number
          • array: BackupSchedule[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: BackupSchedule, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: BackupSchedule

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: BackupSchedule, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: BackupSchedule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: BackupSchedule, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: BackupSchedule

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: BackupSchedule, index: number, array: BackupSchedule[]): U
        • Parameters

          • value: BackupSchedule
          • index: number
          • array: BackupSchedule[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): BackupSchedule | undefined
  • Removes the last element from an array and returns it.

    Returns BackupSchedule | undefined

push

  • push(...items: BackupSchedule[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: BackupSchedule[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): BackupSchedule
  • reduce(callbackfn: function, initialValue: BackupSchedule): BackupSchedule
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: BackupSchedule, currentValue: BackupSchedule, currentIndex: number, array: BackupSchedule[]): BackupSchedule
        • Parameters

          • previousValue: BackupSchedule
          • currentValue: BackupSchedule
          • currentIndex: number
          • array: BackupSchedule[]

          Returns BackupSchedule

    Returns BackupSchedule

  • Parameters

    • callbackfn: function
        • (previousValue: BackupSchedule, currentValue: BackupSchedule, currentIndex: number, array: BackupSchedule[]): BackupSchedule
        • Parameters

          • previousValue: BackupSchedule
          • currentValue: BackupSchedule
          • currentIndex: number
          • array: BackupSchedule[]

          Returns BackupSchedule

    • initialValue: BackupSchedule

    Returns BackupSchedule

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BackupSchedule, currentIndex: number, array: BackupSchedule[]): U
        • Parameters

          • previousValue: U
          • currentValue: BackupSchedule
          • currentIndex: number
          • array: BackupSchedule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): BackupSchedule
  • reduceRight(callbackfn: function, initialValue: BackupSchedule): BackupSchedule
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: BackupSchedule, currentValue: BackupSchedule, currentIndex: number, array: BackupSchedule[]): BackupSchedule
        • Parameters

          • previousValue: BackupSchedule
          • currentValue: BackupSchedule
          • currentIndex: number
          • array: BackupSchedule[]

          Returns BackupSchedule

    Returns BackupSchedule

  • Parameters

    • callbackfn: function
        • (previousValue: BackupSchedule, currentValue: BackupSchedule, currentIndex: number, array: BackupSchedule[]): BackupSchedule
        • Parameters

          • previousValue: BackupSchedule
          • currentValue: BackupSchedule
          • currentIndex: number
          • array: BackupSchedule[]

          Returns BackupSchedule

    • initialValue: BackupSchedule

    Returns BackupSchedule

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BackupSchedule, currentIndex: number, array: BackupSchedule[]): U
        • Parameters

          • previousValue: U
          • currentValue: BackupSchedule
          • currentIndex: number
          • array: BackupSchedule[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): BackupSchedule[]
  • Reverses the elements in an Array.

    Returns BackupSchedule[]

shift

  • shift(): BackupSchedule | undefined
  • Removes the first element from an array and returns it.

    Returns BackupSchedule | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): BackupSchedule[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns BackupSchedule[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: BackupSchedule, index: number, array: BackupSchedule[]): boolean
        • Parameters

          • value: BackupSchedule
          • index: number
          • array: BackupSchedule[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): BackupSchedule[]
  • splice(start: number, deleteCount: number, ...items: BackupSchedule[]): BackupSchedule[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns BackupSchedule[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: BackupSchedule[]

      Elements to insert into the array in place of the deleted elements.

    Returns BackupSchedule[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: BackupSchedule[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: BackupSchedule[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<BackupSchedule>
  • Returns an iterable of values in the array

    Returns IterableIterator<BackupSchedule>

type

type: object

className

className: string = "BackupScheduleList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BackupSchedule"

name

name: "Composite" = "Composite"

Const BandwidthSchedule

BandwidthSchedule: object
interface

An interface representing BandwidthSchedule. The schedule for bandwidth setting.

days

days: DayOfWeek[]
member

{DayOfWeek[]} days The days of the week when this schedule is applicable.

rateInMbps

rateInMbps: number
member

{number} rateInMbps The rate in Mbps.

serializedName

serializedName: string = "BandwidthSchedule"

start

start: Time
member

{Time} start The start time of the schdule.

stop

stop: Time
member

{Time} stop The stop time of the schedule.

type

type: object

className

className: string = "BandwidthSchedule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

days

days: object

required

required: true = true

serializedName

serializedName: string = "days"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]

name

name: "Enum" = "Enum"

rateInMbps

rateInMbps: object

required

required: true = true

serializedName

serializedName: string = "rateInMbps"

type

type: object

name

name: "Number" = "Number"

start

start: object

required

required: true = true

serializedName

serializedName: string = "start"

type

type: object

className

className: string = "Time"

name

name: "Composite" = "Composite"

stop

stop: object

required

required: true = true

serializedName

serializedName: string = "stop"

type

type: object

className

className: string = "Time"

name

name: "Composite" = "Composite"

Const BandwidthSetting

BandwidthSetting: object
interface

An interface representing BandwidthSetting. The bandwidth setting.

extends

BaseModel

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

schedules

schedules: BandwidthSchedule[]
member

{BandwidthSchedule[]} schedules The schedules.

serializedName

serializedName: string = "BandwidthSetting"

Optional volumeCount

volumeCount: undefined | number
member

{number} [volumeCount] The number of volumes that uses the bandwidth setting. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "BandwidthSetting"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

schedules

schedules: object

required

required: true = true

serializedName

serializedName: string = "properties.schedules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BandwidthSchedule"

name

name: "Composite" = "Composite"

volumeCount

volumeCount: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.volumeCount"

type

type: object

name

name: "Number" = "Number"

Const BandwidthSettingList

BandwidthSettingList: object
interface

An interface representing the BandwidthSettingList. The collection of bandwidth setting entities.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "BandwidthSettingList"

__@iterator

  • __@iterator(): IterableIterator<BandwidthSetting>
  • Iterator

    Returns IterableIterator<BandwidthSetting>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<BandwidthSetting>[]): BandwidthSetting[]
  • concat(...items: (T | ConcatArray<T>)[]): BandwidthSetting[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<BandwidthSetting>[]

      Additional items to add to the end of array1.

    Returns BandwidthSetting[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns BandwidthSetting[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, BandwidthSetting]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, BandwidthSetting]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: BandwidthSetting, index: number, array: BandwidthSetting[]): boolean
        • Parameters

          • value: BandwidthSetting
          • index: number
          • array: BandwidthSetting[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: BandwidthSetting, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: BandwidthSetting

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): BandwidthSetting[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: BandwidthSetting

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BandwidthSetting, index: number, array: BandwidthSetting[]): boolean
        • Parameters

          • value: BandwidthSetting
          • index: number
          • array: BandwidthSetting[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BandwidthSetting, index: number, array: BandwidthSetting[]): any
        • Parameters

          • value: BandwidthSetting
          • index: number
          • array: BandwidthSetting[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns BandwidthSetting[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): BandwidthSetting | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: BandwidthSetting

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: BandwidthSetting, index: number, obj: BandwidthSetting[]): boolean
        • Parameters

          • this: void
          • value: BandwidthSetting
          • index: number
          • obj: BandwidthSetting[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: BandwidthSetting, index: number, obj: BandwidthSetting[]): boolean
        • Parameters

          • value: BandwidthSetting
          • index: number
          • obj: BandwidthSetting[]

          Returns boolean

    • Optional thisArg: any

    Returns BandwidthSetting | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: BandwidthSetting, index: number, obj: BandwidthSetting[]): boolean
        • Parameters

          • value: BandwidthSetting
          • index: number
          • obj: BandwidthSetting[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: BandwidthSetting, index: number, array: BandwidthSetting[]): void
        • Parameters

          • value: BandwidthSetting
          • index: number
          • array: BandwidthSetting[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: BandwidthSetting, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: BandwidthSetting

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: BandwidthSetting, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: BandwidthSetting

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: BandwidthSetting, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: BandwidthSetting

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: BandwidthSetting, index: number, array: BandwidthSetting[]): U
        • Parameters

          • value: BandwidthSetting
          • index: number
          • array: BandwidthSetting[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): BandwidthSetting | undefined
  • Removes the last element from an array and returns it.

    Returns BandwidthSetting | undefined

push

  • push(...items: BandwidthSetting[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: BandwidthSetting[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): BandwidthSetting
  • reduce(callbackfn: function, initialValue: BandwidthSetting): BandwidthSetting
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: BandwidthSetting, currentValue: BandwidthSetting, currentIndex: number, array: BandwidthSetting[]): BandwidthSetting
        • Parameters

          • previousValue: BandwidthSetting
          • currentValue: BandwidthSetting
          • currentIndex: number
          • array: BandwidthSetting[]

          Returns BandwidthSetting

    Returns BandwidthSetting

  • Parameters

    • callbackfn: function
        • (previousValue: BandwidthSetting, currentValue: BandwidthSetting, currentIndex: number, array: BandwidthSetting[]): BandwidthSetting
        • Parameters

          • previousValue: BandwidthSetting
          • currentValue: BandwidthSetting
          • currentIndex: number
          • array: BandwidthSetting[]

          Returns BandwidthSetting

    • initialValue: BandwidthSetting

    Returns BandwidthSetting

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BandwidthSetting, currentIndex: number, array: BandwidthSetting[]): U
        • Parameters

          • previousValue: U
          • currentValue: BandwidthSetting
          • currentIndex: number
          • array: BandwidthSetting[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): BandwidthSetting
  • reduceRight(callbackfn: function, initialValue: BandwidthSetting): BandwidthSetting
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: BandwidthSetting, currentValue: BandwidthSetting, currentIndex: number, array: BandwidthSetting[]): BandwidthSetting
        • Parameters

          • previousValue: BandwidthSetting
          • currentValue: BandwidthSetting
          • currentIndex: number
          • array: BandwidthSetting[]

          Returns BandwidthSetting

    Returns BandwidthSetting

  • Parameters

    • callbackfn: function
        • (previousValue: BandwidthSetting, currentValue: BandwidthSetting, currentIndex: number, array: BandwidthSetting[]): BandwidthSetting
        • Parameters

          • previousValue: BandwidthSetting
          • currentValue: BandwidthSetting
          • currentIndex: number
          • array: BandwidthSetting[]

          Returns BandwidthSetting

    • initialValue: BandwidthSetting

    Returns BandwidthSetting

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BandwidthSetting, currentIndex: number, array: BandwidthSetting[]): U
        • Parameters

          • previousValue: U
          • currentValue: BandwidthSetting
          • currentIndex: number
          • array: BandwidthSetting[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): BandwidthSetting[]
  • Reverses the elements in an Array.

    Returns BandwidthSetting[]

shift

  • shift(): BandwidthSetting | undefined
  • Removes the first element from an array and returns it.

    Returns BandwidthSetting | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): BandwidthSetting[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns BandwidthSetting[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: BandwidthSetting, index: number, array: BandwidthSetting[]): boolean
        • Parameters

          • value: BandwidthSetting
          • index: number
          • array: BandwidthSetting[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): BandwidthSetting[]
  • splice(start: number, deleteCount: number, ...items: BandwidthSetting[]): BandwidthSetting[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns BandwidthSetting[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: BandwidthSetting[]

      Elements to insert into the array in place of the deleted elements.

    Returns BandwidthSetting[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: BandwidthSetting[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: BandwidthSetting[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<BandwidthSetting>
  • Returns an iterable of values in the array

    Returns IterableIterator<BandwidthSetting>

type

type: object

className

className: string = "BandwidthSettingList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BandwidthSetting"

name

name: "Composite" = "Composite"

Const BaseModel

BaseModel: object
interface

An interface representing BaseModel. Represents the base class for all other ARM object models

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "BaseModel"

type

type: object
member

{string} [type] The hierarchical type of the object. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "BaseModel"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

kind

kind: object

serializedName

serializedName: string = "kind"

type

type: object

allowedValues

allowedValues: string[] = ["Series8000"]

name

name: "Enum" = "Enum"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ChapSettings

ChapSettings: object
interface

An interface representing ChapSettings. The Challenge-Handshake Authentication Protocol (CHAP) settings.

Optional initiatorSecret

initiatorSecret: AsymmetricEncryptedSecret
member

{AsymmetricEncryptedSecret} [initiatorSecret] The CHAP initiator secret.

Optional initiatorUser

initiatorUser: undefined | string
member

{string} [initiatorUser] The CHAP initiator user.

serializedName

serializedName: string = "ChapSettings"

Optional targetSecret

member

{AsymmetricEncryptedSecret} [targetSecret] The target secret.

Optional targetUser

targetUser: undefined | string
member

{string} [targetUser] The CHAP target user.

type

type: object

className

className: string = "ChapSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

initiatorSecret

initiatorSecret: object

serializedName

serializedName: string = "initiatorSecret"

type

type: object

className

className: string = "AsymmetricEncryptedSecret"

name

name: "Composite" = "Composite"

initiatorUser

initiatorUser: object

serializedName

serializedName: string = "initiatorUser"

type

type: object

name

name: "String" = "String"

targetSecret

targetSecret: object

serializedName

serializedName: string = "targetSecret"

type

type: object

className

className: string = "AsymmetricEncryptedSecret"

name

name: "Composite" = "Composite"

targetUser

targetUser: object

serializedName

serializedName: string = "targetUser"

type

type: object

name

name: "String" = "String"

Const ClearAlertRequest

ClearAlertRequest: object
interface

An interface representing ClearAlertRequest. The request for clearing the alert

alerts

alerts: string[]
member

{string[]} alerts The list of alert IDs to be cleared

Optional resolutionMessage

resolutionMessage: undefined | string
member

{string} [resolutionMessage] The resolution message while clearing the alert

serializedName

serializedName: string = "ClearAlertRequest"

type

type: object

className

className: string = "ClearAlertRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

alerts

alerts: object

required

required: true = true

serializedName

serializedName: string = "alerts"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

resolutionMessage

resolutionMessage: object

serializedName

serializedName: string = "resolutionMessage"

type

type: object

name

name: "String" = "String"

Const CloneRequest

CloneRequest: object
interface

An interface representing CloneRequest. The clone job request.

backupElement

backupElement: BackupElement
member

{BackupElement} backupElement The backup element that is cloned.

serializedName

serializedName: string = "CloneRequest"

targetAccessControlRecordIds

targetAccessControlRecordIds: string[]
member

{string[]} targetAccessControlRecordIds The list of path IDs of the access control records to be associated to the new cloned volume.

targetDeviceId

targetDeviceId: string
member

{string} targetDeviceId The path ID of the device which will act as the clone target.

targetVolumeName

targetVolumeName: string
member

{string} targetVolumeName The name of the new volume which will be created and the backup will be cloned into.

type

type: object

className

className: string = "CloneRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupElement

backupElement: object

required

required: true = true

serializedName

serializedName: string = "backupElement"

type

type: object

className

className: string = "BackupElement"

name

name: "Composite" = "Composite"

targetAccessControlRecordIds

targetAccessControlRecordIds: object

required

required: true = true

serializedName

serializedName: string = "targetAccessControlRecordIds"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

targetDeviceId

targetDeviceId: object

required

required: true = true

serializedName

serializedName: string = "targetDeviceId"

type

type: object

name

name: "String" = "String"

targetVolumeName

targetVolumeName: object

required

required: true = true

serializedName

serializedName: string = "targetVolumeName"

type

type: object

name

name: "String" = "String"

Const CloudAppliance

CloudAppliance: object
interface

An interface representing CloudAppliance. The cloud appliance.

Optional isVnetDnsConfigured

isVnetDnsConfigured: undefined | false | true
member

{boolean} [isVnetDnsConfigured] Indicates whether virtual network used is configured with DNS or not.

Optional isVnetExpressConfigured

isVnetExpressConfigured: undefined | false | true
member

{boolean} [isVnetExpressConfigured] Indicates whether virtual network used is configured with express route or not.

Optional modelNumber

modelNumber: undefined | string
member

{string} [modelNumber] The model number.

name

name: string
member

{string} name The name.

serializedName

serializedName: string = "CloudAppliance"

Optional storageAccountName

storageAccountName: undefined | string
member

{string} [storageAccountName] The name of the storage account.

Optional storageAccountType

storageAccountType: undefined | string
member

{string} [storageAccountType] The type of the storage account.

Optional subnetName

subnetName: undefined | string
member

{string} [subnetName] The name of the subnet.

Optional vmImageName

vmImageName: undefined | string
member

{string} [vmImageName] The name of the virtual machine image.

Optional vmType

vmType: undefined | string
member

{string} [vmType] The type of the virtual machine.

Optional vnetName

vnetName: undefined | string
member

{string} [vnetName] The name of the virtual network.

vnetRegion

vnetRegion: string
member

{string} vnetRegion The virtual network region.

type

type: object

className

className: string = "CloudAppliance"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

isVnetDnsConfigured

isVnetDnsConfigured: object

serializedName

serializedName: string = "isVnetDnsConfigured"

type

type: object

name

name: "Boolean" = "Boolean"

isVnetExpressConfigured

isVnetExpressConfigured: object

serializedName

serializedName: string = "isVnetExpressConfigured"

type

type: object

name

name: "Boolean" = "Boolean"

modelNumber

modelNumber: object

serializedName

serializedName: string = "modelNumber"

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

storageAccountName

storageAccountName: object

serializedName

serializedName: string = "storageAccountName"

type

type: object

name

name: "String" = "String"

storageAccountType

storageAccountType: object

serializedName

serializedName: string = "storageAccountType"

type

type: object

name

name: "String" = "String"

subnetName

subnetName: object

serializedName

serializedName: string = "subnetName"

type

type: object

name

name: "String" = "String"

vmImageName

vmImageName: object

serializedName

serializedName: string = "vmImageName"

type

type: object

name

name: "String" = "String"

vmType

vmType: object

serializedName

serializedName: string = "vmType"

type

type: object

name

name: "String" = "String"

vnetName

vnetName: object

serializedName

serializedName: string = "vnetName"

type

type: object

name

name: "String" = "String"

vnetRegion

vnetRegion: object

required

required: true = true

serializedName

serializedName: string = "vnetRegion"

type

type: object

name

name: "String" = "String"

Const CloudApplianceConfiguration

CloudApplianceConfiguration: object
interface

An interface representing CloudApplianceConfiguration. The cloud appliance configuration

extends

BaseModel

acsConfiguration

acsConfiguration: AcsConfiguration
member

{AcsConfiguration} acsConfiguration The ACS configuration.

cloudPlatform

cloudPlatform: string
member

{string} cloudPlatform The cloud platform.

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

modelNumber

modelNumber: string
member

{string} modelNumber The model number.

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "CloudApplianceConfiguration"

supportedRegions

supportedRegions: string[]
member

{string[]} supportedRegions The supported regions.

supportedStorageAccountTypes

supportedStorageAccountTypes: string[]
member

{string[]} supportedStorageAccountTypes The supported storage account types.

supportedVmImages

supportedVmImages: VmImage[]
member

{VmImage[]} supportedVmImages The supported virtual machine images.

supportedVmTypes

supportedVmTypes: string[]
member

{string[]} supportedVmTypes The supported virtual machine types.

type

type: object

className

className: string = "CloudApplianceConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

acsConfiguration

acsConfiguration: object

required

required: true = true

serializedName

serializedName: string = "properties.acsConfiguration"

type

type: object

className

className: string = "AcsConfiguration"

name

name: "Composite" = "Composite"

cloudPlatform

cloudPlatform: object

required

required: true = true

serializedName

serializedName: string = "properties.cloudPlatform"

type

type: object

name

name: "String" = "String"

modelNumber

modelNumber: object

required

required: true = true

serializedName

serializedName: string = "properties.modelNumber"

type

type: object

name

name: "String" = "String"

supportedRegions

supportedRegions: object

required

required: true = true

serializedName

serializedName: string = "properties.supportedRegions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

supportedStorageAccountTypes

supportedStorageAccountTypes: object

required

required: true = true

serializedName

serializedName: string = "properties.supportedStorageAccountTypes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

supportedVmImages

supportedVmImages: object

required

required: true = true

serializedName

serializedName: string = "properties.supportedVmImages"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VmImage"

name

name: "Composite" = "Composite"

supportedVmTypes

supportedVmTypes: object

required

required: true = true

serializedName

serializedName: string = "properties.supportedVmTypes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const CloudApplianceConfigurationList

CloudApplianceConfigurationList: object
interface

An interface representing the CloudApplianceConfigurationList. The cloud appliance configuration list

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "CloudApplianceConfigurationList"

__@iterator

  • __@iterator(): IterableIterator<CloudApplianceConfiguration>
  • Iterator

    Returns IterableIterator<CloudApplianceConfiguration>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<CloudApplianceConfiguration>[]): CloudApplianceConfiguration[]
  • concat(...items: (T | ConcatArray<T>)[]): CloudApplianceConfiguration[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<CloudApplianceConfiguration>[]

      Additional items to add to the end of array1.

    Returns CloudApplianceConfiguration[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns CloudApplianceConfiguration[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, CloudApplianceConfiguration]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, CloudApplianceConfiguration]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: CloudApplianceConfiguration, index: number, array: CloudApplianceConfiguration[]): boolean
        • Parameters

          • value: CloudApplianceConfiguration
          • index: number
          • array: CloudApplianceConfiguration[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: CloudApplianceConfiguration, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: CloudApplianceConfiguration

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): CloudApplianceConfiguration[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: CloudApplianceConfiguration

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: CloudApplianceConfiguration, index: number, array: CloudApplianceConfiguration[]): boolean
        • Parameters

          • value: CloudApplianceConfiguration
          • index: number
          • array: CloudApplianceConfiguration[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: CloudApplianceConfiguration, index: number, array: CloudApplianceConfiguration[]): any
        • Parameters

          • value: CloudApplianceConfiguration
          • index: number
          • array: CloudApplianceConfiguration[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns CloudApplianceConfiguration[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): CloudApplianceConfiguration | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: CloudApplianceConfiguration

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: CloudApplianceConfiguration, index: number, obj: CloudApplianceConfiguration[]): boolean
        • Parameters

          • this: void
          • value: CloudApplianceConfiguration
          • index: number
          • obj: CloudApplianceConfiguration[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: CloudApplianceConfiguration, index: number, obj: CloudApplianceConfiguration[]): boolean
        • Parameters

          • value: CloudApplianceConfiguration
          • index: number
          • obj: CloudApplianceConfiguration[]

          Returns boolean

    • Optional thisArg: any

    Returns CloudApplianceConfiguration | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: CloudApplianceConfiguration, index: number, obj: CloudApplianceConfiguration[]): boolean
        • Parameters

          • value: CloudApplianceConfiguration
          • index: number
          • obj: CloudApplianceConfiguration[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: CloudApplianceConfiguration, index: number, array: CloudApplianceConfiguration[]): void
        • Parameters

          • value: CloudApplianceConfiguration
          • index: number
          • array: CloudApplianceConfiguration[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: CloudApplianceConfiguration, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: CloudApplianceConfiguration

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: CloudApplianceConfiguration, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: CloudApplianceConfiguration

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: CloudApplianceConfiguration, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: CloudApplianceConfiguration

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: CloudApplianceConfiguration, index: number, array: CloudApplianceConfiguration[]): U
        • Parameters

          • value: CloudApplianceConfiguration
          • index: number
          • array: CloudApplianceConfiguration[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): CloudApplianceConfiguration | undefined
  • Removes the last element from an array and returns it.

    Returns CloudApplianceConfiguration | undefined

push

  • push(...items: CloudApplianceConfiguration[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: CloudApplianceConfiguration[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): CloudApplianceConfiguration
  • reduce(callbackfn: function, initialValue: CloudApplianceConfiguration): CloudApplianceConfiguration
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: CloudApplianceConfiguration, currentValue: CloudApplianceConfiguration, currentIndex: number, array: CloudApplianceConfiguration[]): CloudApplianceConfiguration
        • Parameters

          • previousValue: CloudApplianceConfiguration
          • currentValue: CloudApplianceConfiguration
          • currentIndex: number
          • array: CloudApplianceConfiguration[]

          Returns CloudApplianceConfiguration

    Returns CloudApplianceConfiguration

  • Parameters

    • callbackfn: function
        • (previousValue: CloudApplianceConfiguration, currentValue: CloudApplianceConfiguration, currentIndex: number, array: CloudApplianceConfiguration[]): CloudApplianceConfiguration
        • Parameters

          • previousValue: CloudApplianceConfiguration
          • currentValue: CloudApplianceConfiguration
          • currentIndex: number
          • array: CloudApplianceConfiguration[]

          Returns CloudApplianceConfiguration

    • initialValue: CloudApplianceConfiguration

    Returns CloudApplianceConfiguration

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: CloudApplianceConfiguration, currentIndex: number, array: CloudApplianceConfiguration[]): U
        • Parameters

          • previousValue: U
          • currentValue: CloudApplianceConfiguration
          • currentIndex: number
          • array: CloudApplianceConfiguration[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): CloudApplianceConfiguration
  • reduceRight(callbackfn: function, initialValue: CloudApplianceConfiguration): CloudApplianceConfiguration
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: CloudApplianceConfiguration, currentValue: CloudApplianceConfiguration, currentIndex: number, array: CloudApplianceConfiguration[]): CloudApplianceConfiguration
        • Parameters

          • previousValue: CloudApplianceConfiguration
          • currentValue: CloudApplianceConfiguration
          • currentIndex: number
          • array: CloudApplianceConfiguration[]

          Returns CloudApplianceConfiguration

    Returns CloudApplianceConfiguration

  • Parameters

    • callbackfn: function
        • (previousValue: CloudApplianceConfiguration, currentValue: CloudApplianceConfiguration, currentIndex: number, array: CloudApplianceConfiguration[]): CloudApplianceConfiguration
        • Parameters

          • previousValue: CloudApplianceConfiguration
          • currentValue: CloudApplianceConfiguration
          • currentIndex: number
          • array: CloudApplianceConfiguration[]

          Returns CloudApplianceConfiguration

    • initialValue: CloudApplianceConfiguration

    Returns CloudApplianceConfiguration

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: CloudApplianceConfiguration, currentIndex: number, array: CloudApplianceConfiguration[]): U
        • Parameters

          • previousValue: U
          • currentValue: CloudApplianceConfiguration
          • currentIndex: number
          • array: CloudApplianceConfiguration[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): CloudApplianceConfiguration[]
  • Reverses the elements in an Array.

    Returns CloudApplianceConfiguration[]

shift

  • shift(): CloudApplianceConfiguration | undefined
  • Removes the first element from an array and returns it.

    Returns CloudApplianceConfiguration | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): CloudApplianceConfiguration[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns CloudApplianceConfiguration[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: CloudApplianceConfiguration, index: number, array: CloudApplianceConfiguration[]): boolean
        • Parameters

          • value: CloudApplianceConfiguration
          • index: number
          • array: CloudApplianceConfiguration[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): CloudApplianceConfiguration[]
  • splice(start: number, deleteCount: number, ...items: CloudApplianceConfiguration[]): CloudApplianceConfiguration[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns CloudApplianceConfiguration[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: CloudApplianceConfiguration[]

      Elements to insert into the array in place of the deleted elements.

    Returns CloudApplianceConfiguration[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: CloudApplianceConfiguration[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: CloudApplianceConfiguration[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<CloudApplianceConfiguration>
  • Returns an iterable of values in the array

    Returns IterableIterator<CloudApplianceConfiguration>

type

type: object

className

className: string = "CloudApplianceConfigurationList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CloudApplianceConfiguration"

name

name: "Composite" = "Composite"

Const CloudApplianceSettings

CloudApplianceSettings: object
interface

An interface representing CloudApplianceSettings. The cloud appliance settings.

Optional channelIntegrityKey

channelIntegrityKey: AsymmetricEncryptedSecret
member

{AsymmetricEncryptedSecret} [channelIntegrityKey] The channel integrity key (encrypted with DAK).

serializedName

serializedName: string = "CloudApplianceSettings"

Optional serviceDataEncryptionKey

serviceDataEncryptionKey: AsymmetricEncryptedSecret
member

{AsymmetricEncryptedSecret} [serviceDataEncryptionKey] The service data encryption key (encrypted with DAK).

type

type: object

className

className: string = "CloudApplianceSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

channelIntegrityKey

channelIntegrityKey: object

serializedName

serializedName: string = "channelIntegrityKey"

type

type: object

className

className: string = "AsymmetricEncryptedSecret"

name

name: "Composite" = "Composite"

serviceDataEncryptionKey

serviceDataEncryptionKey: object

serializedName

serializedName: string = "serviceDataEncryptionKey"

type

type: object

className

className: string = "AsymmetricEncryptedSecret"

name

name: "Composite" = "Composite"

Const ConfigureDeviceRequest

ConfigureDeviceRequest: object
interface

An interface representing ConfigureDeviceRequest. The mandatory device configuration request.

extends

BaseModel

currentDeviceName

currentDeviceName: string
member

{string} currentDeviceName The current name of the device.

Optional dnsSettings

member

{SecondaryDNSSettings} [dnsSettings] The secondary DNS Settings of the device.

friendlyName

friendlyName: string
member

{string} friendlyName The friendly name for the device.

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional networkInterfaceData0Settings

networkInterfaceData0Settings: NetworkInterfaceData0Settings
member

{NetworkInterfaceData0Settings} [networkInterfaceData0Settings] The 'Data 0' network interface card settings.

serializedName

serializedName: string = "ConfigureDeviceRequest"

timeZone

timeZone: string
member

{string} timeZone The device time zone. For eg: "Pacific Standard Time"

type

type: object

className

className: string = "ConfigureDeviceRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

currentDeviceName

currentDeviceName: object

required

required: true = true

serializedName

serializedName: string = "properties.currentDeviceName"

type

type: object

name

name: "String" = "String"

dnsSettings

dnsSettings: object

serializedName

serializedName: string = "properties.dnsSettings"

type

type: object

className

className: string = "SecondaryDNSSettings"

name

name: "Composite" = "Composite"

friendlyName

friendlyName: object

required

required: true = true

serializedName

serializedName: string = "properties.friendlyName"

type

type: object

name

name: "String" = "String"

networkInterfaceData0Settings

networkInterfaceData0Settings: object

serializedName

serializedName: string = "properties.networkInterfaceData0Settings"

type

type: object

className

className: string = "NetworkInterfaceData0Settings"

name

name: "Composite" = "Composite"

timeZone

timeZone: object

required

required: true = true

serializedName

serializedName: string = "properties.timeZone"

type

type: object

name

name: "String" = "String"

Const ControllerPowerStateChangeRequest

ControllerPowerStateChangeRequest: object
interface

An interface representing ControllerPowerStateChangeRequest. The controller power state change request.

extends

BaseModel

action

member

{ControllerPowerStateAction} action The power state that the request is expecting for the controller of the device. Possible values include: 'Start', 'Restart', 'Shutdown'

activeController

activeController: ControllerId
member

{ControllerId} activeController The active controller that the request is expecting on the device. Possible values include: 'Unknown', 'None', 'Controller0', 'Controller1'

controller0State

controller0State: ControllerStatus
member

{ControllerStatus} controller0State The controller 0's status that the request is expecting on the device. Possible values include: 'NotPresent', 'PoweredOff', 'Ok', 'Recovering', 'Warning', 'Failure'

controller1State

controller1State: ControllerStatus
member

{ControllerStatus} controller1State The controller 1's status that the request is expecting on the device. Possible values include: 'NotPresent', 'PoweredOff', 'Ok', 'Recovering', 'Warning', 'Failure'

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ControllerPowerStateChangeRequest"

type

type: object

className

className: string = "ControllerPowerStateChangeRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

action

action: object

required

required: true = true

serializedName

serializedName: string = "properties.action"

type

type: object

allowedValues

allowedValues: string[] = ["Start","Restart","Shutdown"]

name

name: "Enum" = "Enum"

activeController

activeController: object

required

required: true = true

serializedName

serializedName: string = "properties.activeController"

type

type: object

allowedValues

allowedValues: string[] = ["Unknown","None","Controller0","Controller1"]

name

name: "Enum" = "Enum"

controller0State

controller0State: object

required

required: true = true

serializedName

serializedName: string = "properties.controller0State"

type

type: object

allowedValues

allowedValues: string[] = ["NotPresent","PoweredOff","Ok","Recovering","Warning","Failure"]

name

name: "Enum" = "Enum"

controller1State

controller1State: object

required

required: true = true

serializedName

serializedName: string = "properties.controller1State"

type

type: object

allowedValues

allowedValues: string[] = ["NotPresent","PoweredOff","Ok","Recovering","Warning","Failure"]

name

name: "Enum" = "Enum"

Const DNSSettings

DNSSettings: object
interface

An interface representing DNSSettings. The DNS(Domain Name Server) settings of a device.

Optional primaryDnsServer

primaryDnsServer: undefined | string
member

{string} [primaryDnsServer] The primary IPv4 DNS server for the device

Optional primaryIpv6DnsServer

primaryIpv6DnsServer: undefined | string
member

{string} [primaryIpv6DnsServer] The primary IPv6 DNS server for the device

Optional secondaryDnsServers

secondaryDnsServers: string[]
member

{string[]} [secondaryDnsServers] The secondary IPv4 DNS server for the device

Optional secondaryIpv6DnsServers

secondaryIpv6DnsServers: string[]
member

{string[]} [secondaryIpv6DnsServers] The secondary IPv6 DNS server for the device

serializedName

serializedName: string = "DNSSettings"

type

type: object

className

className: string = "DNSSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

primaryDnsServer

primaryDnsServer: object

serializedName

serializedName: string = "primaryDnsServer"

type

type: object

name

name: "String" = "String"

primaryIpv6DnsServer

primaryIpv6DnsServer: object

serializedName

serializedName: string = "primaryIpv6DnsServer"

type

type: object

name

name: "String" = "String"

secondaryDnsServers

secondaryDnsServers: object

serializedName

serializedName: string = "secondaryDnsServers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

secondaryIpv6DnsServers

secondaryIpv6DnsServers: object

serializedName

serializedName: string = "secondaryIpv6DnsServers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const DataStatistics

DataStatistics: object
interface

An interface representing DataStatistics. The additional details related to the data related statistics of a job. Currently applicable only for Backup, Clone and Restore jobs.

Optional cloudData

cloudData: undefined | number
member

{number} [cloudData] The number of bytes of data written to cloud, as part of the job.

Optional processedData

processedData: undefined | number
member

{number} [processedData] The number of bytes of data processed till now, as part of the job.

serializedName

serializedName: string = "DataStatistics"

Optional throughput

throughput: undefined | number
member

{number} [throughput] The average throughput of data processed(bytes/sec), as part of the job.

Optional totalData

totalData: undefined | number
member

{number} [totalData] The total bytes of data to be processed, as part of the job.

type

type: object

className

className: string = "DataStatistics"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

cloudData

cloudData: object

serializedName

serializedName: string = "cloudData"

type

type: object

name

name: "Number" = "Number"

processedData

processedData: object

serializedName

serializedName: string = "processedData"

type

type: object

name

name: "Number" = "Number"

throughput

throughput: object

serializedName

serializedName: string = "throughput"

type

type: object

name

name: "Number" = "Number"

totalData

totalData: object

serializedName

serializedName: string = "totalData"

type

type: object

name

name: "Number" = "Number"

Const Device

Device: object
interface

An interface representing Device. The StorSimple device.

extends

BaseModel

activationTime

activationTime: Date
member

{Date} activationTime The UTC time at which the device was activated

activeController

activeController: ControllerId
member

{ControllerId} activeController The identifier of the active controller of the device. Possible values include: 'Unknown', 'None', 'Controller0', 'Controller1'

Optional agentGroupVersion

agentGroupVersion: undefined | number
member

{number} [agentGroupVersion] The device agent group version.

Optional availableLocalStorageInBytes

availableLocalStorageInBytes: undefined | number
member

{number} [availableLocalStorageInBytes] The storage in bytes that is available locally on the device.

Optional availableTieredStorageInBytes

availableTieredStorageInBytes: undefined | number
member

{number} [availableTieredStorageInBytes] The storage in bytes that is available on the device for tiered volumes.

culture

culture: string
member

{string} culture The language culture setting on the device. For eg: "en-US"

Optional details

details: DeviceDetails
member

{DeviceDetails} [details] The additional device details regarding the end point count and volume container count.

deviceConfigurationStatus

deviceConfigurationStatus: DeviceConfigurationStatus
member

{DeviceConfigurationStatus} deviceConfigurationStatus The current configuration status of the device. Possible values include: 'Complete', 'Pending'

deviceDescription

deviceDescription: string
member

{string} deviceDescription The device description.

Optional deviceLocation

deviceLocation: undefined | string
member

{string} [deviceLocation] The location of the virtual appliance.

deviceSoftwareVersion

deviceSoftwareVersion: string
member

{string} deviceSoftwareVersion The version number of the software running on the device.

deviceType

deviceType: DeviceType
member

{DeviceType} deviceType The type of the device. Possible values include: 'Invalid', 'Series8000VirtualAppliance', 'Series8000PhysicalAppliance'

friendlyName

friendlyName: string
member

{string} friendlyName The friendly name of the device.

Optional friendlySoftwareName

friendlySoftwareName: undefined | string
member

{string} [friendlySoftwareName] The friendly name of the software running on the device.

friendlySoftwareVersion

friendlySoftwareVersion: string
member

{string} friendlySoftwareVersion The device friendly software version.

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

modelDescription

modelDescription: string
member

{string} modelDescription The device model.

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional networkInterfaceCardCount

networkInterfaceCardCount: undefined | number
member

{number} [networkInterfaceCardCount] The number of network interface cards

Optional provisionedLocalStorageInBytes

provisionedLocalStorageInBytes: undefined | number
member

{number} [provisionedLocalStorageInBytes] The storage in bytes used for locally pinned volumes on the device (including additional local reservation).

Optional provisionedTieredStorageInBytes

provisionedTieredStorageInBytes: undefined | number
member

{number} [provisionedTieredStorageInBytes] The storage in bytes that has been provisioned on the device for tiered volumes.

Optional provisionedVolumeSizeInBytes

provisionedVolumeSizeInBytes: undefined | number
member

{number} [provisionedVolumeSizeInBytes] Total capacity in bytes of tiered and locally pinned volumes on the device

Optional rolloverDetails

rolloverDetails: DeviceRolloverDetails
member

{DeviceRolloverDetails} [rolloverDetails] The additional device details for the service data encryption key rollover.

serialNumber

serialNumber: string
member

{string} serialNumber The serial number.

serializedName

serializedName: string = "Device"

status

status: DeviceStatus
member

{DeviceStatus} status The current status of the device. Possible values include: 'Unknown', 'Online', 'Offline', 'Deactivated', 'RequiresAttention', 'MaintenanceMode', 'Creating', 'Provisioning', 'Deactivating', 'Deleted', 'ReadyToSetup'

targetIqn

targetIqn: string
member

{string} targetIqn The target IQN.

Optional totalTieredStorageInBytes

totalTieredStorageInBytes: undefined | number
member

{number} [totalTieredStorageInBytes] The total tiered storage available on the device in bytes.

Optional usingStorageInBytes

usingStorageInBytes: undefined | number
member

{number} [usingStorageInBytes] The storage in bytes that is currently being used on the device, including both local and cloud.

Optional virtualMachineApiType

virtualMachineApiType: VirtualMachineApiType
member

{VirtualMachineApiType} [virtualMachineApiType] The virtual machine API type. Possible values include: 'Classic', 'Arm' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "Device"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

activationTime

activationTime: object

required

required: true = true

serializedName

serializedName: string = "properties.activationTime"

type

type: object

name

name: "DateTime" = "DateTime"

activeController

activeController: object

required

required: true = true

serializedName

serializedName: string = "properties.activeController"

type

type: object

allowedValues

allowedValues: string[] = ["Unknown","None","Controller0","Controller1"]

name

name: "Enum" = "Enum"

agentGroupVersion

agentGroupVersion: object

serializedName

serializedName: string = "properties.agentGroupVersion"

type

type: object

name

name: "Number" = "Number"

availableLocalStorageInBytes

availableLocalStorageInBytes: object

serializedName

serializedName: string = "properties.availableLocalStorageInBytes"

type

type: object

name

name: "Number" = "Number"

availableTieredStorageInBytes

availableTieredStorageInBytes: object

serializedName

serializedName: string = "properties.availableTieredStorageInBytes"

type

type: object

name

name: "Number" = "Number"

culture

culture: object

required

required: true = true

serializedName

serializedName: string = "properties.culture"

type

type: object

name

name: "String" = "String"

details

details: object

serializedName

serializedName: string = "properties.details"

type

type: object

className

className: string = "DeviceDetails"

name

name: "Composite" = "Composite"

deviceConfigurationStatus

deviceConfigurationStatus: object

required

required: true = true

serializedName

serializedName: string = "properties.deviceConfigurationStatus"

type

type: object

allowedValues

allowedValues: string[] = ["Complete","Pending"]

name

name: "Enum" = "Enum"

deviceDescription

deviceDescription: object

required

required: true = true

serializedName

serializedName: string = "properties.deviceDescription"

type

type: object

name

name: "String" = "String"

deviceLocation

deviceLocation: object

serializedName

serializedName: string = "properties.deviceLocation"

type

type: object

name

name: "String" = "String"

deviceSoftwareVersion

deviceSoftwareVersion: object

required

required: true = true

serializedName

serializedName: string = "properties.deviceSoftwareVersion"

type

type: object

name

name: "String" = "String"

deviceType

deviceType: object

required

required: true = true

serializedName

serializedName: string = "properties.deviceType"

type

type: object

allowedValues

allowedValues: string[] = ["Invalid","Series8000VirtualAppliance","Series8000PhysicalAppliance"]

name

name: "Enum" = "Enum"

friendlyName

friendlyName: object

required

required: true = true

serializedName

serializedName: string = "properties.friendlyName"

type

type: object

name

name: "String" = "String"

friendlySoftwareName

friendlySoftwareName: object

serializedName

serializedName: string = "properties.friendlySoftwareName"

type

type: object

name

name: "String" = "String"

friendlySoftwareVersion

friendlySoftwareVersion: object

required

required: true = true

serializedName

serializedName: string = "properties.friendlySoftwareVersion"

type

type: object

name

name: "String" = "String"

modelDescription

modelDescription: object

required

required: true = true

serializedName

serializedName: string = "properties.modelDescription"

type

type: object

name

name: "String" = "String"

networkInterfaceCardCount

networkInterfaceCardCount: object

serializedName

serializedName: string = "properties.networkInterfaceCardCount"

type

type: object

name

name: "Number" = "Number"

provisionedLocalStorageInBytes

provisionedLocalStorageInBytes: object

serializedName

serializedName: string = "properties.provisionedLocalStorageInBytes"

type

type: object

name

name: "Number" = "Number"

provisionedTieredStorageInBytes

provisionedTieredStorageInBytes: object

serializedName

serializedName: string = "properties.provisionedTieredStorageInBytes"

type

type: object

name

name: "Number" = "Number"

provisionedVolumeSizeInBytes

provisionedVolumeSizeInBytes: object

serializedName

serializedName: string = "properties.provisionedVolumeSizeInBytes"

type

type: object

name

name: "Number" = "Number"

rolloverDetails

rolloverDetails: object

serializedName

serializedName: string = "properties.rolloverDetails"

type

type: object

className

className: string = "DeviceRolloverDetails"

name

name: "Composite" = "Composite"

serialNumber

serialNumber: object

required

required: true = true

serializedName

serializedName: string = "properties.serialNumber"

type

type: object

name

name: "String" = "String"

status

status: object

required

required: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

allowedValues

allowedValues: string[] = ["Unknown","Online","Offline","Deactivated","RequiresAttention","MaintenanceMode","Creating","Provisioning","Deactivating","Deleted","ReadyToSetup"]

name

name: "Enum" = "Enum"

targetIqn

targetIqn: object

required

required: true = true

serializedName

serializedName: string = "properties.targetIqn"

type

type: object

name

name: "String" = "String"

totalTieredStorageInBytes

totalTieredStorageInBytes: object

serializedName

serializedName: string = "properties.totalTieredStorageInBytes"

type

type: object

name

name: "Number" = "Number"

usingStorageInBytes

usingStorageInBytes: object

serializedName

serializedName: string = "properties.usingStorageInBytes"

type

type: object

name

name: "Number" = "Number"

virtualMachineApiType

virtualMachineApiType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.virtualMachineApiType"

type

type: object

allowedValues

allowedValues: string[] = ["Classic","Arm"]

name

name: "Enum" = "Enum"

Const DeviceDetails

DeviceDetails: object
interface

An interface representing DeviceDetails. The additional device details regarding the end point count and volume container count.

Optional endpointCount

endpointCount: undefined | number
member

{number} [endpointCount] The total number of endpoints that are currently on the device ( i.e. number of volumes).

serializedName

serializedName: string = "DeviceDetails"

Optional volumeContainerCount

volumeContainerCount: undefined | number
member

{number} [volumeContainerCount] The total number of volume containers on the device.

type

type: object

className

className: string = "DeviceDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endpointCount

endpointCount: object

serializedName

serializedName: string = "endpointCount"

type

type: object

name

name: "Number" = "Number"

volumeContainerCount

volumeContainerCount: object

serializedName

serializedName: string = "volumeContainerCount"

type

type: object

name

name: "Number" = "Number"

Const DeviceList

DeviceList: object
interface

An interface representing the DeviceList. The collection of devices.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "DeviceList"

__@iterator

  • __@iterator(): IterableIterator<Device>
  • Iterator

    Returns IterableIterator<Device>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Device>[]): Device[]
  • concat(...items: (T | ConcatArray<T>)[]): Device[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Device>[]

      Additional items to add to the end of array1.

    Returns Device[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Device[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Device]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Device]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Device, index: number, array: Device[]): boolean
        • Parameters

          • value: Device
          • index: number
          • array: Device[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Device, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Device

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Device[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Device

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Device, index: number, array: Device[]): boolean
        • Parameters

          • value: Device
          • index: number
          • array: Device[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Device, index: number, array: Device[]): any
        • Parameters

          • value: Device
          • index: number
          • array: Device[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Device[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Device | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Device

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Device, index: number, obj: Device[]): boolean
        • Parameters

          • this: void
          • value: Device
          • index: number
          • obj: Device[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Device, index: number, obj: Device[]): boolean
        • Parameters

          • value: Device
          • index: number
          • obj: Device[]

          Returns boolean

    • Optional thisArg: any

    Returns Device | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Device, index: number, obj: Device[]): boolean
        • Parameters

          • value: Device
          • index: number
          • obj: Device[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Device, index: number, array: Device[]): void
        • Parameters

          • value: Device
          • index: number
          • array: Device[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Device, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Device

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Device, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Device

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Device, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Device

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Device, index: number, array: Device[]): U
        • Parameters

          • value: Device
          • index: number
          • array: Device[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Device | undefined
  • Removes the last element from an array and returns it.

    Returns Device | undefined

push

  • push(...items: Device[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Device[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Device
  • reduce(callbackfn: function, initialValue: Device): Device
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Device, currentValue: Device, currentIndex: number, array: Device[]): Device
        • Parameters

          • previousValue: Device
          • currentValue: Device
          • currentIndex: number
          • array: Device[]

          Returns Device

    Returns Device

  • Parameters

    • callbackfn: function
        • (previousValue: Device, currentValue: Device, currentIndex: number, array: Device[]): Device
        • Parameters

          • previousValue: Device
          • currentValue: Device
          • currentIndex: number
          • array: Device[]

          Returns Device

    • initialValue: Device

    Returns Device

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Device, currentIndex: number, array: Device[]): U
        • Parameters

          • previousValue: U
          • currentValue: Device
          • currentIndex: number
          • array: Device[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Device
  • reduceRight(callbackfn: function, initialValue: Device): Device
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Device, currentValue: Device, currentIndex: number, array: Device[]): Device
        • Parameters

          • previousValue: Device
          • currentValue: Device
          • currentIndex: number
          • array: Device[]

          Returns Device

    Returns Device

  • Parameters

    • callbackfn: function
        • (previousValue: Device, currentValue: Device, currentIndex: number, array: Device[]): Device
        • Parameters

          • previousValue: Device
          • currentValue: Device
          • currentIndex: number
          • array: Device[]

          Returns Device

    • initialValue: Device

    Returns Device

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Device, currentIndex: number, array: Device[]): U
        • Parameters

          • previousValue: U
          • currentValue: Device
          • currentIndex: number
          • array: Device[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Device[]
  • Reverses the elements in an Array.

    Returns Device[]

shift

  • shift(): Device | undefined
  • Removes the first element from an array and returns it.

    Returns Device | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Device[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Device[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Device, index: number, array: Device[]): boolean
        • Parameters

          • value: Device
          • index: number
          • array: Device[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Device[]
  • splice(start: number, deleteCount: number, ...items: Device[]): Device[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Device[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Device[]

      Elements to insert into the array in place of the deleted elements.

    Returns Device[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Device[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Device[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Device>
  • Returns an iterable of values in the array

    Returns IterableIterator<Device>

type

type: object

className

className: string = "DeviceList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Device"

name

name: "Composite" = "Composite"

Const DevicePatch

DevicePatch: object
interface

An interface representing DevicePatch. The device patch.

Optional deviceDescription

deviceDescription: undefined | string
member

{string} [deviceDescription] Short description given for the device

serializedName

serializedName: string = "DevicePatch"

type

type: object

className

className: string = "DevicePatch"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

deviceDescription

deviceDescription: object

serializedName

serializedName: string = "properties.deviceDescription"

type

type: object

name

name: "String" = "String"

Const DeviceRolloverDetails

DeviceRolloverDetails: object
interface

An interface representing DeviceRolloverDetails. The additional device details for the service data encryption key rollover.

Optional authorizationEligibility

authorizationEligibility: AuthorizationEligibility
member

{AuthorizationEligibility} [authorizationEligibility] The eligibility status of device for service data encryption key rollover. Possible values include: 'InEligible', 'Eligible'

Optional authorizationStatus

authorizationStatus: AuthorizationStatus
member

{AuthorizationStatus} [authorizationStatus] The authorization status of the device for service data encryption key rollover. Possible values include: 'Disabled', 'Enabled'

Optional inEligibilityReason

inEligibilityReason: InEligibilityCategory
member

{InEligibilityCategory} [inEligibilityReason] The reason for inEligibility of device, in case it's not eligible for service data encryption key rollover. Possible values include: 'DeviceNotOnline', 'NotSupportedAppliance', 'RolloverPending'

serializedName

serializedName: string = "DeviceRolloverDetails"

type

type: object

className

className: string = "DeviceRolloverDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authorizationEligibility

authorizationEligibility: object

serializedName

serializedName: string = "authorizationEligibility"

type

type: object

allowedValues

allowedValues: string[] = ["InEligible","Eligible"]

name

name: "Enum" = "Enum"

authorizationStatus

authorizationStatus: object

serializedName

serializedName: string = "authorizationStatus"

type

type: object

allowedValues

allowedValues: string[] = ["Disabled","Enabled"]

name

name: "Enum" = "Enum"

inEligibilityReason

inEligibilityReason: object

serializedName

serializedName: string = "inEligibilityReason"

type

type: object

allowedValues

allowedValues: string[] = ["DeviceNotOnline","NotSupportedAppliance","RolloverPending"]

name

name: "Enum" = "Enum"

Const DimensionFilter

DimensionFilter: object
interface

An interface representing DimensionFilter. The dimension filter.

Optional name

name: undefined | string
member

{string} [name] Specifies the dimension name. E.g., NetworkInterface. Valid values are the ones specified in the field "dimensions" in the ListMetricDefinitions call. Only 'Equality' operator is supported for this property.

serializedName

serializedName: string = "DimensionFilter"

Optional values

values: undefined | string
member

{string} [values] Specifies the dimension value. E.g., Data0. Valid values are the ones returned in the field "dimensions" in the ListMetricDefinitions call. Only 'Equality' operator is supported for this property.

type

type: object

className

className: string = "DimensionFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

values

values: object

serializedName

serializedName: string = "values"

type

type: object

name

name: "String" = "String"

Const EncryptionSettings

EncryptionSettings: object
interface

An interface representing EncryptionSettings. The encryption settings.

extends

BaseModel

encryptionStatus

encryptionStatus: EncryptionStatus
member

{EncryptionStatus} encryptionStatus The encryption status to indicates if encryption is enabled or not. Possible values include: 'Enabled', 'Disabled'

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

keyRolloverStatus

keyRolloverStatus: KeyRolloverStatus
member

{KeyRolloverStatus} keyRolloverStatus The key rollover status to indicates if key rollover is required or not. If secret's encryption has been upgraded, then it requires key rollover. Possible values include: 'Required', 'NotRequired'

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "EncryptionSettings"

type

type: object

className

className: string = "EncryptionSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

encryptionStatus

encryptionStatus: object

required

required: true = true

serializedName

serializedName: string = "properties.encryptionStatus"

type

type: object

allowedValues

allowedValues: string[] = ["Enabled","Disabled"]

name

name: "Enum" = "Enum"

keyRolloverStatus

keyRolloverStatus: object

required

required: true = true

serializedName

serializedName: string = "properties.keyRolloverStatus"

type

type: object

allowedValues

allowedValues: string[] = ["Required","NotRequired"]

name

name: "Enum" = "Enum"

Const FailoverRequest

FailoverRequest: object
interface

An interface representing FailoverRequest. The request object for triggering a failover of volume containers, from a source device to a target device.

serializedName

serializedName: string = "FailoverRequest"

Optional targetDeviceId

targetDeviceId: undefined | string
member

{string} [targetDeviceId] The ARM path ID of the device which will act as the failover target.

Optional volumeContainers

volumeContainers: string[]
member

{string[]} [volumeContainers] The list of path IDs of the volume containers which needs to be failed-over to the target device.

type

type: object

className

className: string = "FailoverRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

targetDeviceId

targetDeviceId: object

serializedName

serializedName: string = "targetDeviceId"

type

type: object

name

name: "String" = "String"

volumeContainers

volumeContainers: object

serializedName

serializedName: string = "volumeContainers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const FailoverSet

FailoverSet: object
interface

An interface representing FailoverSet. The failover set on a device.

Optional eligibilityResult

eligibilityResult: FailoverSetEligibilityResult
member

{FailoverSetEligibilityResult} [eligibilityResult] The eligibility result of the failover set, for failover.

serializedName

serializedName: string = "FailoverSet"

Optional volumeContainers

volumeContainers: VolumeContainerFailoverMetadata[]
member

{VolumeContainerFailoverMetadata[]} [volumeContainers] The list of meta data of volume containers, which are part of the failover set.

type

type: object

className

className: string = "FailoverSet"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eligibilityResult

eligibilityResult: object

serializedName

serializedName: string = "eligibilityResult"

type

type: object

className

className: string = "FailoverSetEligibilityResult"

name

name: "Composite" = "Composite"

volumeContainers

volumeContainers: object

serializedName

serializedName: string = "volumeContainers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VolumeContainerFailoverMetadata"

name

name: "Composite" = "Composite"

Const FailoverSetEligibilityResult

FailoverSetEligibilityResult: object
interface

An interface representing FailoverSetEligibilityResult. The eligibility result of failover set, for failover.

Optional errorMessage

errorMessage: undefined | string
member

{string} [errorMessage] The error message, if the failover set is not eligible for failover.

Optional isEligibleForFailover

isEligibleForFailover: undefined | false | true
member

{boolean} [isEligibleForFailover] Represents if this failover set is eligible for failover or not.

serializedName

serializedName: string = "FailoverSetEligibilityResult"

type

type: object

className

className: string = "FailoverSetEligibilityResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

errorMessage

errorMessage: object

serializedName

serializedName: string = "errorMessage"

type

type: object

name

name: "String" = "String"

isEligibleForFailover

isEligibleForFailover: object

serializedName

serializedName: string = "isEligibleForFailover"

type

type: object

name

name: "Boolean" = "Boolean"

Const FailoverSetsList

FailoverSetsList: object
interface

An interface representing the FailoverSetsList. The list of failover sets.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "FailoverSetsList"

__@iterator

  • __@iterator(): IterableIterator<FailoverSet>
  • Iterator

    Returns IterableIterator<FailoverSet>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<FailoverSet>[]): FailoverSet[]
  • concat(...items: (T | ConcatArray<T>)[]): FailoverSet[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<FailoverSet>[]

      Additional items to add to the end of array1.

    Returns FailoverSet[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns FailoverSet[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, FailoverSet]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, FailoverSet]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: FailoverSet, index: number, array: FailoverSet[]): boolean
        • Parameters

          • value: FailoverSet
          • index: number
          • array: FailoverSet[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: FailoverSet, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: FailoverSet

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): FailoverSet[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: FailoverSet

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: FailoverSet, index: number, array: FailoverSet[]): boolean
        • Parameters

          • value: FailoverSet
          • index: number
          • array: FailoverSet[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: FailoverSet, index: number, array: FailoverSet[]): any
        • Parameters

          • value: FailoverSet
          • index: number
          • array: FailoverSet[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns FailoverSet[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): FailoverSet | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: FailoverSet

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: FailoverSet, index: number, obj: FailoverSet[]): boolean
        • Parameters

          • this: void
          • value: FailoverSet
          • index: number
          • obj: FailoverSet[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: FailoverSet, index: number, obj: FailoverSet[]): boolean
        • Parameters

          • value: FailoverSet
          • index: number
          • obj: FailoverSet[]

          Returns boolean

    • Optional thisArg: any

    Returns FailoverSet | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: FailoverSet, index: number, obj: FailoverSet[]): boolean
        • Parameters

          • value: FailoverSet
          • index: number
          • obj: FailoverSet[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: FailoverSet, index: number, array: FailoverSet[]): void
        • Parameters

          • value: FailoverSet
          • index: number
          • array: FailoverSet[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: FailoverSet, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: FailoverSet

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: FailoverSet, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: FailoverSet

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: FailoverSet, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: FailoverSet

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: FailoverSet, index: number, array: FailoverSet[]): U
        • Parameters

          • value: FailoverSet
          • index: number
          • array: FailoverSet[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): FailoverSet | undefined
  • Removes the last element from an array and returns it.

    Returns FailoverSet | undefined

push

  • push(...items: FailoverSet[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: FailoverSet[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): FailoverSet
  • reduce(callbackfn: function, initialValue: FailoverSet): FailoverSet
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: FailoverSet, currentValue: FailoverSet, currentIndex: number, array: FailoverSet[]): FailoverSet
        • Parameters

          • previousValue: FailoverSet
          • currentValue: FailoverSet
          • currentIndex: number
          • array: FailoverSet[]

          Returns FailoverSet

    Returns FailoverSet

  • Parameters

    • callbackfn: function
        • (previousValue: FailoverSet, currentValue: FailoverSet, currentIndex: number, array: FailoverSet[]): FailoverSet
        • Parameters

          • previousValue: FailoverSet
          • currentValue: FailoverSet
          • currentIndex: number
          • array: FailoverSet[]

          Returns FailoverSet

    • initialValue: FailoverSet

    Returns FailoverSet

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: FailoverSet, currentIndex: number, array: FailoverSet[]): U
        • Parameters

          • previousValue: U
          • currentValue: FailoverSet
          • currentIndex: number
          • array: FailoverSet[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): FailoverSet
  • reduceRight(callbackfn: function, initialValue: FailoverSet): FailoverSet
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: FailoverSet, currentValue: FailoverSet, currentIndex: number, array: FailoverSet[]): FailoverSet
        • Parameters

          • previousValue: FailoverSet
          • currentValue: FailoverSet
          • currentIndex: number
          • array: FailoverSet[]

          Returns FailoverSet

    Returns FailoverSet

  • Parameters

    • callbackfn: function
        • (previousValue: FailoverSet, currentValue: FailoverSet, currentIndex: number, array: FailoverSet[]): FailoverSet
        • Parameters

          • previousValue: FailoverSet
          • currentValue: FailoverSet
          • currentIndex: number
          • array: FailoverSet[]

          Returns FailoverSet

    • initialValue: FailoverSet

    Returns FailoverSet

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: FailoverSet, currentIndex: number, array: FailoverSet[]): U
        • Parameters

          • previousValue: U
          • currentValue: FailoverSet
          • currentIndex: number
          • array: FailoverSet[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): FailoverSet[]
  • Reverses the elements in an Array.

    Returns FailoverSet[]

shift

  • shift(): FailoverSet | undefined
  • Removes the first element from an array and returns it.

    Returns FailoverSet | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): FailoverSet[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns FailoverSet[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: FailoverSet, index: number, array: FailoverSet[]): boolean
        • Parameters

          • value: FailoverSet
          • index: number
          • array: FailoverSet[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): FailoverSet[]
  • splice(start: number, deleteCount: number, ...items: FailoverSet[]): FailoverSet[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns FailoverSet[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: FailoverSet[]

      Elements to insert into the array in place of the deleted elements.

    Returns FailoverSet[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: FailoverSet[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: FailoverSet[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<FailoverSet>
  • Returns an iterable of values in the array

    Returns IterableIterator<FailoverSet>

type

type: object

className

className: string = "FailoverSetsList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "FailoverSet"

name

name: "Composite" = "Composite"

Const FailoverTarget

FailoverTarget: object
interface

An interface representing FailoverTarget. Represents the eligibility of a device as a failover target device.

Optional availableLocalStorageInBytes

availableLocalStorageInBytes: undefined | number
member

{number} [availableLocalStorageInBytes] The amount of free local storage available on the device in bytes.

Optional availableTieredStorageInBytes

availableTieredStorageInBytes: undefined | number
member

{number} [availableTieredStorageInBytes] The amount of free tiered storage available for the device in bytes.

Optional dataContainersCount

dataContainersCount: undefined | number
member

{number} [dataContainersCount] The count of datacontainers on the device.

Optional deviceId

deviceId: undefined | string
member

{string} [deviceId] The path ID of the device.

Optional deviceLocation

deviceLocation: undefined | string
member

{string} [deviceLocation] The geo location (applicable only for cloud appliances) of the device.

Optional deviceSoftwareVersion

deviceSoftwareVersion: undefined | string
member

{string} [deviceSoftwareVersion] The software version of the device.

Optional deviceStatus

deviceStatus: DeviceStatus
member

{DeviceStatus} [deviceStatus] The status of the device. Possible values include: 'Unknown', 'Online', 'Offline', 'Deactivated', 'RequiresAttention', 'MaintenanceMode', 'Creating', 'Provisioning', 'Deactivating', 'Deleted', 'ReadyToSetup'

Optional eligibilityResult

eligibilityResult: TargetEligibilityResult
member

{TargetEligibilityResult} [eligibilityResult] The eligibility result of the device, as a failover target device.

Optional friendlyDeviceSoftwareVersion

friendlyDeviceSoftwareVersion: undefined | string
member

{string} [friendlyDeviceSoftwareVersion] The friendly name for the current version of software on the device.

Optional modelDescription

modelDescription: undefined | string
member

{string} [modelDescription] The model number of the device.

serializedName

serializedName: string = "FailoverTarget"

Optional volumesCount

volumesCount: undefined | number
member

{number} [volumesCount] The count of volumes on the device.

type

type: object

className

className: string = "FailoverTarget"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

availableLocalStorageInBytes

availableLocalStorageInBytes: object

serializedName

serializedName: string = "availableLocalStorageInBytes"

type

type: object

name

name: "Number" = "Number"

availableTieredStorageInBytes

availableTieredStorageInBytes: object

serializedName

serializedName: string = "availableTieredStorageInBytes"

type

type: object

name

name: "Number" = "Number"

dataContainersCount

dataContainersCount: object

serializedName

serializedName: string = "dataContainersCount"

type

type: object

name

name: "Number" = "Number"

deviceId

deviceId: object

serializedName

serializedName: string = "deviceId"

type

type: object

name

name: "String" = "String"

deviceLocation

deviceLocation: object

serializedName

serializedName: string = "deviceLocation"

type

type: object

name

name: "String" = "String"

deviceSoftwareVersion

deviceSoftwareVersion: object

serializedName

serializedName: string = "deviceSoftwareVersion"

type

type: object

name

name: "String" = "String"

deviceStatus

deviceStatus: object

serializedName

serializedName: string = "deviceStatus"

type

type: object

allowedValues

allowedValues: string[] = ["Unknown","Online","Offline","Deactivated","RequiresAttention","MaintenanceMode","Creating","Provisioning","Deactivating","Deleted","ReadyToSetup"]

name

name: "Enum" = "Enum"

eligibilityResult

eligibilityResult: object

serializedName

serializedName: string = "eligibilityResult"

type

type: object

className

className: string = "TargetEligibilityResult"

name

name: "Composite" = "Composite"

friendlyDeviceSoftwareVersion

friendlyDeviceSoftwareVersion: object

serializedName

serializedName: string = "friendlyDeviceSoftwareVersion"

type

type: object

name

name: "String" = "String"

modelDescription

modelDescription: object

serializedName

serializedName: string = "modelDescription"

type

type: object

name

name: "String" = "String"

volumesCount

volumesCount: object

serializedName

serializedName: string = "volumesCount"

type

type: object

name

name: "Number" = "Number"

Const FailoverTargetsList

FailoverTargetsList: object
interface

An interface representing the FailoverTargetsList. The list of all devices in a resource and their eligibility status as a failover target device.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "FailoverTargetsList"

__@iterator

  • __@iterator(): IterableIterator<FailoverTarget>
  • Iterator

    Returns IterableIterator<FailoverTarget>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<FailoverTarget>[]): FailoverTarget[]
  • concat(...items: (T | ConcatArray<T>)[]): FailoverTarget[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<FailoverTarget>[]

      Additional items to add to the end of array1.

    Returns FailoverTarget[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns FailoverTarget[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, FailoverTarget]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, FailoverTarget]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: FailoverTarget, index: number, array: FailoverTarget[]): boolean
        • Parameters

          • value: FailoverTarget
          • index: number
          • array: FailoverTarget[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: FailoverTarget, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: FailoverTarget

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): FailoverTarget[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: FailoverTarget

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: FailoverTarget, index: number, array: FailoverTarget[]): boolean
        • Parameters

          • value: FailoverTarget
          • index: number
          • array: FailoverTarget[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: FailoverTarget, index: number, array: FailoverTarget[]): any
        • Parameters

          • value: FailoverTarget
          • index: number
          • array: FailoverTarget[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns FailoverTarget[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): FailoverTarget | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: FailoverTarget

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: FailoverTarget, index: number, obj: FailoverTarget[]): boolean
        • Parameters

          • this: void
          • value: FailoverTarget
          • index: number
          • obj: FailoverTarget[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: FailoverTarget, index: number, obj: FailoverTarget[]): boolean
        • Parameters

          • value: FailoverTarget
          • index: number
          • obj: FailoverTarget[]

          Returns boolean

    • Optional thisArg: any

    Returns FailoverTarget | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: FailoverTarget, index: number, obj: FailoverTarget[]): boolean
        • Parameters

          • value: FailoverTarget
          • index: number
          • obj: FailoverTarget[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: FailoverTarget, index: number, array: FailoverTarget[]): void
        • Parameters

          • value: FailoverTarget
          • index: number
          • array: FailoverTarget[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: FailoverTarget, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: FailoverTarget

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: FailoverTarget, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: FailoverTarget

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: FailoverTarget, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: FailoverTarget

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: FailoverTarget, index: number, array: FailoverTarget[]): U
        • Parameters

          • value: FailoverTarget
          • index: number
          • array: FailoverTarget[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): FailoverTarget | undefined
  • Removes the last element from an array and returns it.

    Returns FailoverTarget | undefined

push

  • push(...items: FailoverTarget[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: FailoverTarget[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): FailoverTarget
  • reduce(callbackfn: function, initialValue: FailoverTarget): FailoverTarget
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: FailoverTarget, currentValue: FailoverTarget, currentIndex: number, array: FailoverTarget[]): FailoverTarget
        • Parameters

          • previousValue: FailoverTarget
          • currentValue: FailoverTarget
          • currentIndex: number
          • array: FailoverTarget[]

          Returns FailoverTarget

    Returns FailoverTarget

  • Parameters

    • callbackfn: function
        • (previousValue: FailoverTarget, currentValue: FailoverTarget, currentIndex: number, array: FailoverTarget[]): FailoverTarget
        • Parameters

          • previousValue: FailoverTarget
          • currentValue: FailoverTarget
          • currentIndex: number
          • array: FailoverTarget[]

          Returns FailoverTarget

    • initialValue: FailoverTarget

    Returns FailoverTarget

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: FailoverTarget, currentIndex: number, array: FailoverTarget[]): U
        • Parameters

          • previousValue: U
          • currentValue: FailoverTarget
          • currentIndex: number
          • array: FailoverTarget[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): FailoverTarget
  • reduceRight(callbackfn: function, initialValue: FailoverTarget): FailoverTarget
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: FailoverTarget, currentValue: FailoverTarget, currentIndex: number, array: FailoverTarget[]): FailoverTarget
        • Parameters

          • previousValue: FailoverTarget
          • currentValue: FailoverTarget
          • currentIndex: number
          • array: FailoverTarget[]

          Returns FailoverTarget

    Returns FailoverTarget

  • Parameters

    • callbackfn: function
        • (previousValue: FailoverTarget, currentValue: FailoverTarget, currentIndex: number, array: FailoverTarget[]): FailoverTarget
        • Parameters

          • previousValue: FailoverTarget
          • currentValue: FailoverTarget
          • currentIndex: number
          • array: FailoverTarget[]

          Returns FailoverTarget

    • initialValue: FailoverTarget

    Returns FailoverTarget

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: FailoverTarget, currentIndex: number, array: FailoverTarget[]): U
        • Parameters

          • previousValue: U
          • currentValue: FailoverTarget
          • currentIndex: number
          • array: FailoverTarget[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): FailoverTarget[]
  • Reverses the elements in an Array.

    Returns FailoverTarget[]

shift

  • shift(): FailoverTarget | undefined
  • Removes the first element from an array and returns it.

    Returns FailoverTarget | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): FailoverTarget[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns FailoverTarget[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: FailoverTarget, index: number, array: FailoverTarget[]): boolean
        • Parameters

          • value: FailoverTarget
          • index: number
          • array: FailoverTarget[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): FailoverTarget[]
  • splice(start: number, deleteCount: number, ...items: FailoverTarget[]): FailoverTarget[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns FailoverTarget[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: FailoverTarget[]

      Elements to insert into the array in place of the deleted elements.

    Returns FailoverTarget[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: FailoverTarget[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: FailoverTarget[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<FailoverTarget>
  • Returns an iterable of values in the array

    Returns IterableIterator<FailoverTarget>

type

type: object

className

className: string = "FailoverTargetsList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "FailoverTarget"

name

name: "Composite" = "Composite"

Const Feature

Feature: object
interface

An interface representing Feature. The feature.

name

name: string
member

{string} name The name of the feature.

serializedName

serializedName: string = "Feature"

status

member

{FeatureSupportStatus} status The feature support status. Possible values include: 'NotAvailable', 'UnsupportedDeviceVersion', 'Supported'

type

type: object

className

className: string = "Feature"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

status

status: object

required

required: true = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["NotAvailable","UnsupportedDeviceVersion","Supported"]

name

name: "Enum" = "Enum"

Const FeatureFilter

FeatureFilter: object
interface

An interface representing FeatureFilter. The OData filter to be used for features.

Optional deviceId

deviceId: undefined | string
member

{string} [deviceId] Specifies the device ID for which the features are required. Only 'Equality' operator is supported for this property.

serializedName

serializedName: string = "FeatureFilter"

type

type: object

className

className: string = "FeatureFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

deviceId

deviceId: object

serializedName

serializedName: string = "deviceId"

type

type: object

name

name: "String" = "String"

Const FeatureList

FeatureList: object
interface

An interface representing the FeatureList. The collections of features.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "FeatureList"

__@iterator

  • __@iterator(): IterableIterator<Feature>
  • Iterator

    Returns IterableIterator<Feature>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Feature>[]): Feature[]
  • concat(...items: (T | ConcatArray<T>)[]): Feature[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Feature>[]

      Additional items to add to the end of array1.

    Returns Feature[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Feature[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Feature]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Feature]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Feature, index: number, array: Feature[]): boolean
        • Parameters

          • value: Feature
          • index: number
          • array: Feature[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Feature, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Feature

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Feature[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Feature

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Feature, index: number, array: Feature[]): boolean
        • Parameters

          • value: Feature
          • index: number
          • array: Feature[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Feature, index: number, array: Feature[]): any
        • Parameters

          • value: Feature
          • index: number
          • array: Feature[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Feature[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Feature | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Feature

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Feature, index: number, obj: Feature[]): boolean
        • Parameters

          • this: void
          • value: Feature
          • index: number
          • obj: Feature[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Feature, index: number, obj: Feature[]): boolean
        • Parameters

          • value: Feature
          • index: number
          • obj: Feature[]

          Returns boolean

    • Optional thisArg: any

    Returns Feature | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Feature, index: number, obj: Feature[]): boolean
        • Parameters

          • value: Feature
          • index: number
          • obj: Feature[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Feature, index: number, array: Feature[]): void
        • Parameters

          • value: Feature
          • index: number
          • array: Feature[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Feature, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Feature

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Feature, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Feature

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Feature, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Feature

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Feature, index: number, array: Feature[]): U
        • Parameters

          • value: Feature
          • index: number
          • array: Feature[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Feature | undefined
  • Removes the last element from an array and returns it.

    Returns Feature | undefined

push

  • push(...items: Feature[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Feature[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Feature
  • reduce(callbackfn: function, initialValue: Feature): Feature
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Feature, currentValue: Feature, currentIndex: number, array: Feature[]): Feature
        • Parameters

          • previousValue: Feature
          • currentValue: Feature
          • currentIndex: number
          • array: Feature[]

          Returns Feature

    Returns Feature

  • Parameters

    • callbackfn: function
        • (previousValue: Feature, currentValue: Feature, currentIndex: number, array: Feature[]): Feature
        • Parameters

          • previousValue: Feature
          • currentValue: Feature
          • currentIndex: number
          • array: Feature[]

          Returns Feature

    • initialValue: Feature

    Returns Feature

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Feature, currentIndex: number, array: Feature[]): U
        • Parameters

          • previousValue: U
          • currentValue: Feature
          • currentIndex: number
          • array: Feature[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Feature
  • reduceRight(callbackfn: function, initialValue: Feature): Feature
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Feature, currentValue: Feature, currentIndex: number, array: Feature[]): Feature
        • Parameters

          • previousValue: Feature
          • currentValue: Feature
          • currentIndex: number
          • array: Feature[]

          Returns Feature

    Returns Feature

  • Parameters

    • callbackfn: function
        • (previousValue: Feature, currentValue: Feature, currentIndex: number, array: Feature[]): Feature
        • Parameters

          • previousValue: Feature
          • currentValue: Feature
          • currentIndex: number
          • array: Feature[]

          Returns Feature

    • initialValue: Feature

    Returns Feature

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Feature, currentIndex: number, array: Feature[]): U
        • Parameters

          • previousValue: U
          • currentValue: Feature
          • currentIndex: number
          • array: Feature[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Feature[]
  • Reverses the elements in an Array.

    Returns Feature[]

shift

  • shift(): Feature | undefined
  • Removes the first element from an array and returns it.

    Returns Feature | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Feature[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Feature[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Feature, index: number, array: Feature[]): boolean
        • Parameters

          • value: Feature
          • index: number
          • array: Feature[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Feature[]
  • splice(start: number, deleteCount: number, ...items: Feature[]): Feature[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Feature[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Feature[]

      Elements to insert into the array in place of the deleted elements.

    Returns Feature[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Feature[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Feature[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Feature>
  • Returns an iterable of values in the array

    Returns IterableIterator<Feature>

type

type: object

className

className: string = "FeatureList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Feature"

name

name: "Composite" = "Composite"

Const HardwareComponent

HardwareComponent: object
interface

An interface representing HardwareComponent. The hardware component.

componentId

componentId: string
member

{string} componentId The component ID.

displayName

displayName: string
member

{string} displayName The display name of the hardware component.

serializedName

serializedName: string = "HardwareComponent"

status

member

{HardwareComponentStatus} status The status of the hardware component. Possible values include: 'Unknown', 'NotPresent', 'PoweredOff', 'Ok', 'Recovering', 'Warning', 'Failure'

statusDisplayName

statusDisplayName: string
member

{string} statusDisplayName The display name of the status of hardware component.

type

type: object

className

className: string = "HardwareComponent"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

componentId

componentId: object

required

required: true = true

serializedName

serializedName: string = "componentId"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

required

required: true = true

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

status

status: object

required

required: true = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["Unknown","NotPresent","PoweredOff","Ok","Recovering","Warning","Failure"]

name

name: "Enum" = "Enum"

statusDisplayName

statusDisplayName: object

required

required: true = true

serializedName

serializedName: string = "statusDisplayName"

type

type: object

name

name: "String" = "String"

Const HardwareComponentGroup

HardwareComponentGroup: object
interface

An interface representing HardwareComponentGroup. The hardware component group.

extends

BaseModel

components

components: HardwareComponent[]
member

{HardwareComponent[]} components The list of hardware components.

displayName

displayName: string
member

{string} displayName The display name the hardware component group.

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

lastUpdatedTime

lastUpdatedTime: Date
member

{Date} lastUpdatedTime The last updated time.

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "HardwareComponentGroup"

type

type: object

className

className: string = "HardwareComponentGroup"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

components

components: object

required

required: true = true

serializedName

serializedName: string = "properties.components"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HardwareComponent"

name

name: "Composite" = "Composite"

displayName

displayName: object

required

required: true = true

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: "String" = "String"

lastUpdatedTime

lastUpdatedTime: object

required

required: true = true

serializedName

serializedName: string = "properties.lastUpdatedTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const HardwareComponentGroupList

HardwareComponentGroupList: object
interface

An interface representing the HardwareComponentGroupList. The collection of hardware component groups.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "HardwareComponentGroupList"

__@iterator

  • __@iterator(): IterableIterator<HardwareComponentGroup>
  • Iterator

    Returns IterableIterator<HardwareComponentGroup>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<HardwareComponentGroup>[]): HardwareComponentGroup[]
  • concat(...items: (T | ConcatArray<T>)[]): HardwareComponentGroup[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<HardwareComponentGroup>[]

      Additional items to add to the end of array1.

    Returns HardwareComponentGroup[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns HardwareComponentGroup[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, HardwareComponentGroup]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, HardwareComponentGroup]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: HardwareComponentGroup, index: number, array: HardwareComponentGroup[]): boolean
        • Parameters

          • value: HardwareComponentGroup
          • index: number
          • array: HardwareComponentGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: HardwareComponentGroup, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: HardwareComponentGroup

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): HardwareComponentGroup[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: HardwareComponentGroup

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: HardwareComponentGroup, index: number, array: HardwareComponentGroup[]): boolean
        • Parameters

          • value: HardwareComponentGroup
          • index: number
          • array: HardwareComponentGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: HardwareComponentGroup, index: number, array: HardwareComponentGroup[]): any
        • Parameters

          • value: HardwareComponentGroup
          • index: number
          • array: HardwareComponentGroup[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns HardwareComponentGroup[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): HardwareComponentGroup | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: HardwareComponentGroup

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: HardwareComponentGroup, index: number, obj: HardwareComponentGroup[]): boolean
        • Parameters

          • this: void
          • value: HardwareComponentGroup
          • index: number
          • obj: HardwareComponentGroup[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: HardwareComponentGroup, index: number, obj: HardwareComponentGroup[]): boolean
        • Parameters

          • value: HardwareComponentGroup
          • index: number
          • obj: HardwareComponentGroup[]

          Returns boolean

    • Optional thisArg: any

    Returns HardwareComponentGroup | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: HardwareComponentGroup, index: number, obj: HardwareComponentGroup[]): boolean
        • Parameters

          • value: HardwareComponentGroup
          • index: number
          • obj: HardwareComponentGroup[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: HardwareComponentGroup, index: number, array: HardwareComponentGroup[]): void
        • Parameters

          • value: HardwareComponentGroup
          • index: number
          • array: HardwareComponentGroup[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: HardwareComponentGroup, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: HardwareComponentGroup

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: HardwareComponentGroup, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: HardwareComponentGroup

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: HardwareComponentGroup, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: HardwareComponentGroup

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: HardwareComponentGroup, index: number, array: HardwareComponentGroup[]): U
        • Parameters

          • value: HardwareComponentGroup
          • index: number
          • array: HardwareComponentGroup[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): HardwareComponentGroup | undefined
  • Removes the last element from an array and returns it.

    Returns HardwareComponentGroup | undefined

push

  • push(...items: HardwareComponentGroup[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: HardwareComponentGroup[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): HardwareComponentGroup
  • reduce(callbackfn: function, initialValue: HardwareComponentGroup): HardwareComponentGroup
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: HardwareComponentGroup, currentValue: HardwareComponentGroup, currentIndex: number, array: HardwareComponentGroup[]): HardwareComponentGroup
        • Parameters

          • previousValue: HardwareComponentGroup
          • currentValue: HardwareComponentGroup
          • currentIndex: number
          • array: HardwareComponentGroup[]

          Returns HardwareComponentGroup

    Returns HardwareComponentGroup

  • Parameters

    • callbackfn: function
        • (previousValue: HardwareComponentGroup, currentValue: HardwareComponentGroup, currentIndex: number, array: HardwareComponentGroup[]): HardwareComponentGroup
        • Parameters

          • previousValue: HardwareComponentGroup
          • currentValue: HardwareComponentGroup
          • currentIndex: number
          • array: HardwareComponentGroup[]

          Returns HardwareComponentGroup

    • initialValue: HardwareComponentGroup

    Returns HardwareComponentGroup

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: HardwareComponentGroup, currentIndex: number, array: HardwareComponentGroup[]): U
        • Parameters

          • previousValue: U
          • currentValue: HardwareComponentGroup
          • currentIndex: number
          • array: HardwareComponentGroup[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): HardwareComponentGroup
  • reduceRight(callbackfn: function, initialValue: HardwareComponentGroup): HardwareComponentGroup
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: HardwareComponentGroup, currentValue: HardwareComponentGroup, currentIndex: number, array: HardwareComponentGroup[]): HardwareComponentGroup
        • Parameters

          • previousValue: HardwareComponentGroup
          • currentValue: HardwareComponentGroup
          • currentIndex: number
          • array: HardwareComponentGroup[]

          Returns HardwareComponentGroup

    Returns HardwareComponentGroup

  • Parameters

    • callbackfn: function
        • (previousValue: HardwareComponentGroup, currentValue: HardwareComponentGroup, currentIndex: number, array: HardwareComponentGroup[]): HardwareComponentGroup
        • Parameters

          • previousValue: HardwareComponentGroup
          • currentValue: HardwareComponentGroup
          • currentIndex: number
          • array: HardwareComponentGroup[]

          Returns HardwareComponentGroup

    • initialValue: HardwareComponentGroup

    Returns HardwareComponentGroup

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: HardwareComponentGroup, currentIndex: number, array: HardwareComponentGroup[]): U
        • Parameters

          • previousValue: U
          • currentValue: HardwareComponentGroup
          • currentIndex: number
          • array: HardwareComponentGroup[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): HardwareComponentGroup[]
  • Reverses the elements in an Array.

    Returns HardwareComponentGroup[]

shift

  • shift(): HardwareComponentGroup | undefined
  • Removes the first element from an array and returns it.

    Returns HardwareComponentGroup | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): HardwareComponentGroup[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns HardwareComponentGroup[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: HardwareComponentGroup, index: number, array: HardwareComponentGroup[]): boolean
        • Parameters

          • value: HardwareComponentGroup
          • index: number
          • array: HardwareComponentGroup[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): HardwareComponentGroup[]
  • splice(start: number, deleteCount: number, ...items: HardwareComponentGroup[]): HardwareComponentGroup[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns HardwareComponentGroup[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: HardwareComponentGroup[]

      Elements to insert into the array in place of the deleted elements.

    Returns HardwareComponentGroup[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: HardwareComponentGroup[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: HardwareComponentGroup[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<HardwareComponentGroup>
  • Returns an iterable of values in the array

    Returns IterableIterator<HardwareComponentGroup>

type

type: object

className

className: string = "HardwareComponentGroupList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HardwareComponentGroup"

name

name: "Composite" = "Composite"

Const Job

Job: object
interface

An interface representing Job. The job.

extends

BaseModel

Optional backupPointInTime

backupPointInTime: Date
member

{Date} [backupPointInTime] The time of the backup used for the failover.

Optional backupType

backupType: BackupType
member

{BackupType} [backupType] The backup type (CloudSnapshot | LocalSnapshot). Applicable only for backup jobs. Possible values include: 'LocalSnapshot', 'CloudSnapshot'

Optional dataStats

dataStats: DataStatistics
member

{DataStatistics} [dataStats] The data statistics properties of the job.

Optional deviceId

deviceId: undefined | string
member

{string} [deviceId] The device ID in which the job ran.

Optional endTime

endTime: Date
member

{Date} [endTime] The UTC time at which the job completed.

Optional entityLabel

entityLabel: undefined | string
member

{string} [entityLabel] The entity identifier for which the job ran.

Optional entityType

entityType: undefined | string
member

{string} [entityType] The entity type for which the job ran.

Optional error

member

{JobErrorDetails} [error] The error details, if any, for the job.

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isCancellable

isCancellable: undefined | false | true
member

{boolean} [isCancellable] Represents whether the job is cancellable or not.

Optional jobStages

jobStages: JobStage[]
member

{JobStage[]} [jobStages] The job stages.

jobType

jobType: JobType
member

{JobType} jobType The type of the job. Possible values include: 'ScheduledBackup', 'ManualBackup', 'RestoreBackup', 'CloneVolume', 'FailoverVolumeContainers', 'CreateLocallyPinnedVolume', 'ModifyVolume', 'InstallUpdates', 'SupportPackageLogs', 'CreateCloudAppliance'

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

percentComplete

percentComplete: number
member

{number} percentComplete The percentage of the job that is already complete.

serializedName

serializedName: string = "Job"

Optional sourceDeviceId

sourceDeviceId: undefined | string
member

{string} [sourceDeviceId] The source device ID of the failover job.

Optional startTime

startTime: Date
member

{Date} [startTime] The UTC time at which the job was started.

status

status: JobStatus
member

{JobStatus} status The current status of the job. Possible values include: 'Running', 'Succeeded', 'Failed', 'Canceled'

type

type: object

className

className: string = "Job"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupPointInTime

backupPointInTime: object

serializedName

serializedName: string = "properties.backupPointInTime"

type

type: object

name

name: "DateTime" = "DateTime"

backupType

backupType: object

serializedName

serializedName: string = "properties.backupType"

type

type: object

allowedValues

allowedValues: string[] = ["LocalSnapshot","CloudSnapshot"]

name

name: "Enum" = "Enum"

dataStats

dataStats: object

serializedName

serializedName: string = "properties.dataStats"

type

type: object

className

className: string = "DataStatistics"

name

name: "Composite" = "Composite"

deviceId

deviceId: object

serializedName

serializedName: string = "properties.deviceId"

type

type: object

name

name: "String" = "String"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

entityLabel

entityLabel: object

serializedName

serializedName: string = "properties.entityLabel"

type

type: object

name

name: "String" = "String"

entityType

entityType: object

serializedName

serializedName: string = "properties.entityType"

type

type: object

name

name: "String" = "String"

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "JobErrorDetails"

name

name: "Composite" = "Composite"

isCancellable

isCancellable: object

serializedName

serializedName: string = "properties.isCancellable"

type

type: object

name

name: "Boolean" = "Boolean"

jobStages

jobStages: object

serializedName

serializedName: string = "properties.jobStages"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "JobStage"

name

name: "Composite" = "Composite"

jobType

jobType: object

required

required: true = true

serializedName

serializedName: string = "properties.jobType"

type

type: object

allowedValues

allowedValues: string[] = ["ScheduledBackup","ManualBackup","RestoreBackup","CloneVolume","FailoverVolumeContainers","CreateLocallyPinnedVolume","ModifyVolume","InstallUpdates","SupportPackageLogs","CreateCloudAppliance"]

name

name: "Enum" = "Enum"

percentComplete

percentComplete: object

required

required: true = true

serializedName

serializedName: string = "percentComplete"

type

type: object

name

name: "Number" = "Number"

sourceDeviceId

sourceDeviceId: object

serializedName

serializedName: string = "properties.sourceDeviceId"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

required

required: true = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["Running","Succeeded","Failed","Canceled"]

name

name: "Enum" = "Enum"

Const JobErrorDetails

JobErrorDetails: object
interface

An interface representing JobErrorDetails. The job error details. Contains list of job error items.

code

code: string
member

{string} code The error code intended for programmatic access.

Optional errorDetails

errorDetails: JobErrorItem[]
member

{JobErrorItem[]} [errorDetails] The error details.

message

message: string
member

{string} message The error message intended to describe the error in detail.

serializedName

serializedName: string = "JobErrorDetails"

type

type: object

className

className: string = "JobErrorDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

required

required: true = true

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

errorDetails

errorDetails: object

serializedName

serializedName: string = "errorDetails"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "JobErrorItem"

name

name: "Composite" = "Composite"

message

message: object

required

required: true = true

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

Const JobErrorItem

JobErrorItem: object
interface

An interface representing JobErrorItem. The job error items.

code

code: string
member

{string} code The error code intended for programmatic access.

message

message: string
member

{string} message The error message intended to describe the error in detail.

Optional recommendations

recommendations: string[]
member

{string[]} [recommendations] The recommended actions.

serializedName

serializedName: string = "JobErrorItem"

type

type: object

className

className: string = "JobErrorItem"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

required

required: true = true

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

required

required: true = true

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

recommendations

recommendations: object

serializedName

serializedName: string = "recommendations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const JobFilter

JobFilter: object
interface

An interface representing JobFilter. The OData filter to be used for jobs.

Optional jobType

jobType: undefined | string
member

{string} [jobType] Specifies the type of the jobs to be filtered. For e.g., "ScheduledBackup", "ManualBackup", "RestoreBackup", "CloneVolume", "FailoverVolumeContainers", "CreateLocallyPinnedVolume", "ModifyVolume", "InstallUpdates", "SupportPackageLogs", or "CreateCloudAppliance". Only 'Equality' operator can be used for this property.

serializedName

serializedName: string = "JobFilter"

Optional startTime

startTime: Date
member

{Date} [startTime] Specifies the start time of the jobs to be filtered. Only 'Greater Than or Equal To' and 'Lesser Than or Equal To' operators are supported for this property.

Optional status

status: undefined | string
member

{string} [status] Specifies the status of the jobs to be filtered. For e.g., "Running", "Succeeded", "Failed" or "Canceled". Only 'Equality' operator is supported for this property.

type

type: object

className

className: string = "JobFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

jobType

jobType: object

serializedName

serializedName: string = "jobType"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const JobList

JobList: object
interface

An interface representing the JobList. The collection of jobs.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string
member

{string} [nextLink] The NextLink.

serializedName

serializedName: string = "JobList"

__@iterator

  • __@iterator(): IterableIterator<Job>
  • Iterator

    Returns IterableIterator<Job>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Job>[]): Job[]
  • concat(...items: (T | ConcatArray<T>)[]): Job[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Job>[]

      Additional items to add to the end of array1.

    Returns Job[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Job[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Job]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Job]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Job, index: number, array: Job[]): boolean
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Job, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Job

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Job[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Job

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Job, index: number, array: Job[]): boolean
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Job, index: number, array: Job[]): any
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Job[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Job | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Job

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Job, index: number, obj: Job[]): boolean
        • Parameters

          • this: void
          • value: Job
          • index: number
          • obj: Job[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Job, index: number, obj: Job[]): boolean
        • Parameters

          • value: Job
          • index: number
          • obj: Job[]

          Returns boolean

    • Optional thisArg: any

    Returns Job | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Job, index: number, obj: Job[]): boolean
        • Parameters

          • value: Job
          • index: number
          • obj: Job[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Job, index: number, array: Job[]): void
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Job, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Job

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Job, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Job

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Job, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Job

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Job, index: number, array: Job[]): U
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Job | undefined
  • Removes the last element from an array and returns it.

    Returns Job | undefined

push

  • push(...items: Job[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Job[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Job
  • reduce(callbackfn: function, initialValue: Job): Job
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Job, currentValue: Job, currentIndex: number, array: Job[]): Job
        • Parameters

          • previousValue: Job
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns Job

    Returns Job

  • Parameters

    • callbackfn: function
        • (previousValue: Job, currentValue: Job, currentIndex: number, array: Job[]): Job
        • Parameters

          • previousValue: Job
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns Job

    • initialValue: Job

    Returns Job

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Job, currentIndex: number, array: Job[]): U
        • Parameters

          • previousValue: U
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Job
  • reduceRight(callbackfn: function, initialValue: Job): Job
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Job, currentValue: Job, currentIndex: number, array: Job[]): Job
        • Parameters

          • previousValue: Job
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns Job

    Returns Job

  • Parameters

    • callbackfn: function
        • (previousValue: Job, currentValue: Job, currentIndex: number, array: Job[]): Job
        • Parameters

          • previousValue: Job
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns Job

    • initialValue: Job

    Returns Job

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Job, currentIndex: number, array: Job[]): U
        • Parameters

          • previousValue: U
          • currentValue: Job
          • currentIndex: number
          • array: Job[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Job[]
  • Reverses the elements in an Array.

    Returns Job[]

shift

  • shift(): Job | undefined
  • Removes the first element from an array and returns it.

    Returns Job | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Job[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Job[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Job, index: number, array: Job[]): boolean
        • Parameters

          • value: Job
          • index: number
          • array: Job[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Job[]
  • splice(start: number, deleteCount: number, ...items: Job[]): Job[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Job[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Job[]

      Elements to insert into the array in place of the deleted elements.

    Returns Job[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Job[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Job[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Job>
  • Returns an iterable of values in the array

    Returns IterableIterator<Job>

type

type: object

className

className: string = "JobList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Job"

name

name: "Composite" = "Composite"

Const JobStage

JobStage: object
interface

An interface representing JobStage. The details about the specific stage of a job.

Optional detail

detail: undefined | string
member

{string} [detail] The details of the stage.

Optional errorCode

errorCode: undefined | string
member

{string} [errorCode] The error code of the stage if any.

Optional message

message: undefined | string
member

{string} [message] The message of the job stage.

serializedName

serializedName: string = "JobStage"

stageStatus

stageStatus: JobStatus
member

{JobStatus} stageStatus The stage status. Possible values include: 'Running', 'Succeeded', 'Failed', 'Canceled'

type

type: object

className

className: string = "JobStage"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

detail

detail: object

serializedName

serializedName: string = "detail"

type

type: object

name

name: "String" = "String"

errorCode

errorCode: object

serializedName

serializedName: string = "errorCode"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

stageStatus

stageStatus: object

required

required: true = true

serializedName

serializedName: string = "stageStatus"

type

type: object

allowedValues

allowedValues: string[] = ["Running","Succeeded","Failed","Canceled"]

name

name: "Enum" = "Enum"

Const Key

Key: object
interface

An interface representing Key. The key.

activationKey

activationKey: string
member

{string} activationKey The activation key for the device.

serializedName

serializedName: string = "Key"

type

type: object

className

className: string = "Key"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

activationKey

activationKey: object

required

required: true = true

serializedName

serializedName: string = "activationKey"

type

type: object

name

name: "String" = "String"

Const ListFailoverTargetsRequest

ListFailoverTargetsRequest: object
interface

An interface representing ListFailoverTargetsRequest. The request object for fetching the list of failover targets (eligible devices for failover).

serializedName

serializedName: string = "ListFailoverTargetsRequest"

Optional volumeContainers

volumeContainers: string[]
member

{string[]} [volumeContainers] The list of path IDs of the volume containers that needs to be failed-over, for which we want to fetch the eligible targets.

type

type: object

className

className: string = "ListFailoverTargetsRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

volumeContainers

volumeContainers: object

serializedName

serializedName: string = "volumeContainers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const Manager

Manager: object
interface

An interface representing Manager. The StorSimple Manager.

extends

Resource

Optional cisIntrinsicSettings

cisIntrinsicSettings: ManagerIntrinsicSettings
member

{ManagerIntrinsicSettings} [cisIntrinsicSettings] Represents the type of StorSimple Manager.

Optional etag

etag: undefined | string
member

{string} [etag] The etag of the manager.

Optional id

id: undefined | string
member

{string} [id] The resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string
member

{string} location The geo location of the resource.

Optional name

name: undefined | string
member

{string} [name] The resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: undefined | string
member

{string} [provisioningState] Specifies the state of the resource as it is getting provisioned. Value of "Succeeded" means the Manager was successfully created.

serializedName

serializedName: string = "Manager"

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] The tags attached to the resource.

type

type: object

className

className: string = "Manager"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

cisIntrinsicSettings

cisIntrinsicSettings: object

serializedName

serializedName: string = "properties.cisIntrinsicSettings"

type

type: object

className

className: string = "ManagerIntrinsicSettings"

name

name: "Composite" = "Composite"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

sku

sku: object

defaultValue

defaultValue: object

Type declaration

isConstant

isConstant: true = true

serializedName

serializedName: string = "properties.sku"

type

type: object

className

className: string = "ManagerSku"

name

name: "Composite" = "Composite"

Const ManagerExtendedInfo

ManagerExtendedInfo: object
interface

An interface representing ManagerExtendedInfo. The extended info of the manager.

extends

BaseModel

algorithm

algorithm: string
member

{string} algorithm Represents the encryption algorithm used to encrypt the keys. None - if Key is saved in plain text format. Algorithm name - if key is encrypted

Optional encryptionKey

encryptionKey: undefined | string
member

{string} [encryptionKey] Represents the CEK of the resource.

Optional encryptionKeyThumbprint

encryptionKeyThumbprint: undefined | string
member

{string} [encryptionKeyThumbprint] Represents the Cert thumbprint that was used to encrypt the CEK.

Optional etag

etag: undefined | string
member

{string} [etag] The etag of the resource.

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

integrityKey

integrityKey: string
member

{string} integrityKey Represents the CIK of the resource.

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional portalCertificateThumbprint

portalCertificateThumbprint: undefined | string
member

{string} [portalCertificateThumbprint] Represents the portal thumbprint which can be used optionally to encrypt the entire data before storing it.

serializedName

serializedName: string = "ManagerExtendedInfo"

Optional version

version: undefined | string
member

{string} [version] The version of the extended info being persisted.

type

type: object

className

className: string = "ManagerExtendedInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

algorithm

algorithm: object

required

required: true = true

serializedName

serializedName: string = "properties.algorithm"

type

type: object

name

name: "String" = "String"

encryptionKey

encryptionKey: object

serializedName

serializedName: string = "properties.encryptionKey"

type

type: object

name

name: "String" = "String"

encryptionKeyThumbprint

encryptionKeyThumbprint: object

serializedName

serializedName: string = "properties.encryptionKeyThumbprint"

type

type: object

name

name: "String" = "String"

etag

etag: object

serializedName

serializedName: string = "etag"

type

type: object

name

name: "String" = "String"

integrityKey

integrityKey: object

required

required: true = true

serializedName

serializedName: string = "properties.integrityKey"

type

type: object

name

name: "String" = "String"

portalCertificateThumbprint

portalCertificateThumbprint: object

serializedName

serializedName: string = "properties.portalCertificateThumbprint"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "properties.version"

type

type: object

name

name: "String" = "String"

Const ManagerIntrinsicSettings

ManagerIntrinsicSettings: object
interface

An interface representing ManagerIntrinsicSettings. Intrinsic settings which refers to the type of the Storsimple Manager.

serializedName

serializedName: string = "ManagerIntrinsicSettings"

type

type: object
member

{ManagerType} type The type of StorSimple Manager. Possible values include: 'GardaV1', 'HelsinkiV1'

className

className: string = "ManagerIntrinsicSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

allowedValues

allowedValues: string[] = ["GardaV1","HelsinkiV1"]

name

name: "Enum" = "Enum"

Const ManagerList

ManagerList: object
interface

An interface representing the ManagerList. The list of StorSimple Managers.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "ManagerList"

__@iterator

  • __@iterator(): IterableIterator<Manager>
  • Iterator

    Returns IterableIterator<Manager>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Manager>[]): Manager[]
  • concat(...items: (T | ConcatArray<T>)[]): Manager[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Manager>[]

      Additional items to add to the end of array1.

    Returns Manager[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Manager[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Manager]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Manager]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Manager, index: number, array: Manager[]): boolean
        • Parameters

          • value: Manager
          • index: number
          • array: Manager[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Manager, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Manager

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Manager[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Manager

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Manager, index: number, array: Manager[]): boolean
        • Parameters

          • value: Manager
          • index: number
          • array: Manager[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Manager, index: number, array: Manager[]): any
        • Parameters

          • value: Manager
          • index: number
          • array: Manager[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Manager[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Manager | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Manager

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Manager, index: number, obj: Manager[]): boolean
        • Parameters

          • this: void
          • value: Manager
          • index: number
          • obj: Manager[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Manager, index: number, obj: Manager[]): boolean
        • Parameters

          • value: Manager
          • index: number
          • obj: Manager[]

          Returns boolean

    • Optional thisArg: any

    Returns Manager | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Manager, index: number, obj: Manager[]): boolean
        • Parameters

          • value: Manager
          • index: number
          • obj: Manager[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Manager, index: number, array: Manager[]): void
        • Parameters

          • value: Manager
          • index: number
          • array: Manager[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Manager, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Manager

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Manager, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Manager

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Manager, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Manager

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Manager, index: number, array: Manager[]): U
        • Parameters

          • value: Manager
          • index: number
          • array: Manager[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Manager | undefined
  • Removes the last element from an array and returns it.

    Returns Manager | undefined

push

  • push(...items: Manager[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Manager[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Manager
  • reduce(callbackfn: function, initialValue: Manager): Manager
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Manager, currentValue: Manager, currentIndex: number, array: Manager[]): Manager
        • Parameters

          • previousValue: Manager
          • currentValue: Manager
          • currentIndex: number
          • array: Manager[]

          Returns Manager

    Returns Manager

  • Parameters

    • callbackfn: function
        • (previousValue: Manager, currentValue: Manager, currentIndex: number, array: Manager[]): Manager
        • Parameters

          • previousValue: Manager
          • currentValue: Manager
          • currentIndex: number
          • array: Manager[]

          Returns Manager

    • initialValue: Manager

    Returns Manager

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Manager, currentIndex: number, array: Manager[]): U
        • Parameters

          • previousValue: U
          • currentValue: Manager
          • currentIndex: number
          • array: Manager[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Manager
  • reduceRight(callbackfn: function, initialValue: Manager): Manager
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Manager, currentValue: Manager, currentIndex: number, array: Manager[]): Manager
        • Parameters

          • previousValue: Manager
          • currentValue: Manager
          • currentIndex: number
          • array: Manager[]

          Returns Manager

    Returns Manager

  • Parameters

    • callbackfn: function
        • (previousValue: Manager, currentValue: Manager, currentIndex: number, array: Manager[]): Manager
        • Parameters

          • previousValue: Manager
          • currentValue: Manager
          • currentIndex: number
          • array: Manager[]

          Returns Manager

    • initialValue: Manager

    Returns Manager

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Manager, currentIndex: number, array: Manager[]): U
        • Parameters

          • previousValue: U
          • currentValue: Manager
          • currentIndex: number
          • array: Manager[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Manager[]
  • Reverses the elements in an Array.

    Returns Manager[]

shift

  • shift(): Manager | undefined
  • Removes the first element from an array and returns it.

    Returns Manager | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Manager[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Manager[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Manager, index: number, array: Manager[]): boolean
        • Parameters

          • value: Manager
          • index: number
          • array: Manager[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Manager[]
  • splice(start: number, deleteCount: number, ...items: Manager[]): Manager[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Manager[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Manager[]

      Elements to insert into the array in place of the deleted elements.

    Returns Manager[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Manager[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Manager[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Manager>
  • Returns an iterable of values in the array

    Returns IterableIterator<Manager>

type

type: object

className

className: string = "ManagerList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Manager"

name

name: "Composite" = "Composite"

Const ManagerPatch

ManagerPatch: object
interface

An interface representing ManagerPatch. The StorSimple Manager patch.

serializedName

serializedName: string = "ManagerPatch"

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] The tags attached to the Manager.

type

type: object

className

className: string = "ManagerPatch"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const ManagerSku

ManagerSku: object
interface

An interface representing ManagerSku. The Sku.

serializedName

serializedName: string = "ManagerSku"

type

type: object

className

className: string = "ManagerSku"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

defaultValue

defaultValue: string = "Standard"

isConstant

isConstant: true = true

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const MetricAvailablity

MetricAvailablity: object
interface

An interface representing MetricAvailablity. The metric availability.

Optional retention

retention: undefined | string
member

{string} [retention] The retention period for the metric at the specified timegrain.

serializedName

serializedName: string = "MetricAvailablity"

Optional timeGrain

timeGrain: undefined | string
member

{string} [timeGrain] The aggregation interval for the metric.

type

type: object

className

className: string = "MetricAvailablity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

retention

retention: object

serializedName

serializedName: string = "retention"

type

type: object

name

name: "String" = "String"

timeGrain

timeGrain: object

serializedName

serializedName: string = "timeGrain"

type

type: object

name

name: "String" = "String"

Const MetricData

MetricData: object
interface

An interface representing MetricData. The metric data.

Optional average

average: undefined | number
member

{number} [average] The average of all samples at the time stamp.

Optional count

count: undefined | number
member

{number} [count] The count of all samples at the time stamp.

Optional maximum

maximum: undefined | number
member

{number} [maximum] The maximum of all samples at the time stamp.

Optional minimum

minimum: undefined | number
member

{number} [minimum] The minimum of all samples at the time stamp.

serializedName

serializedName: string = "MetricData"

Optional sum

sum: undefined | number
member

{number} [sum] The sum of all samples at the time stamp.

Optional timeStamp

timeStamp: Date
member

{Date} [timeStamp] The time stamp of the metric data.

type

type: object

className

className: string = "MetricData"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

average

average: object

serializedName

serializedName: string = "average"

type

type: object

name

name: "Number" = "Number"

count

count: object

serializedName

serializedName: string = "count"

type

type: object

name

name: "Number" = "Number"

maximum

maximum: object

serializedName

serializedName: string = "maximum"

type

type: object

name

name: "Number" = "Number"

minimum

minimum: object

serializedName

serializedName: string = "minimum"

type

type: object

name

name: "Number" = "Number"

sum

sum: object

serializedName

serializedName: string = "sum"

type

type: object

name

name: "Number" = "Number"

timeStamp

timeStamp: object

serializedName

serializedName: string = "timeStamp"

type

type: object

name

name: "DateTime" = "DateTime"

Const MetricDefinition

MetricDefinition: object
interface

An interface representing MetricDefinition. The monitoring metric definition.

Optional category

category: undefined | string
member

{string} [category] The category of the metric.

Optional dimensions

dimensions: MetricDimension[]
member

{MetricDimension[]} [dimensions] The available metric dimensions.

Optional metricAvailabilities

metricAvailabilities: MetricAvailablity[]
member

{MetricAvailablity[]} [metricAvailabilities] The available metric granularities.

Optional name

member

{MetricName} [name] The metric name.

Optional primaryAggregationType

primaryAggregationType: MetricAggregationType
member

{MetricAggregationType} [primaryAggregationType] The metric aggregation type. Possible values include: 'Average', 'Last', 'Maximum', 'Minimum', 'None', 'Total'

Optional resourceId

resourceId: undefined | string
member

{string} [resourceId] The metric source ID.

serializedName

serializedName: string = "MetricDefinition"

Optional unit

member

{MetricUnit} [unit] The metric unit. Possible values include: 'Bytes', 'BytesPerSecond', 'Count', 'CountPerSecond', 'Percent', 'Seconds'

type

type: object
member

{string} [type] The metric definition type.

className

className: string = "MetricDefinition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

category

category: object

serializedName

serializedName: string = "category"

type

type: object

name

name: "String" = "String"

dimensions

dimensions: object

serializedName

serializedName: string = "dimensions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricDimension"

name

name: "Composite" = "Composite"

metricAvailabilities

metricAvailabilities: object

serializedName

serializedName: string = "metricAvailabilities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricAvailablity"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

className

className: string = "MetricName"

name

name: "Composite" = "Composite"

primaryAggregationType

primaryAggregationType: object

serializedName

serializedName: string = "primaryAggregationType"

type

type: object

allowedValues

allowedValues: string[] = ["Average","Last","Maximum","Minimum","None","Total"]

name

name: "Enum" = "Enum"

resourceId

resourceId: object

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

unit

unit: object

serializedName

serializedName: string = "unit"

type

type: object

allowedValues

allowedValues: string[] = ["Bytes","BytesPerSecond","Count","CountPerSecond","Percent","Seconds"]

name

name: "Enum" = "Enum"

Const MetricDefinitionList

MetricDefinitionList: object
interface

An interface representing the MetricDefinitionList. The list of metric definitions.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "MetricDefinitionList"

__@iterator

  • __@iterator(): IterableIterator<MetricDefinition>
  • Iterator

    Returns IterableIterator<MetricDefinition>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<MetricDefinition>[]): MetricDefinition[]
  • concat(...items: (T | ConcatArray<T>)[]): MetricDefinition[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<MetricDefinition>[]

      Additional items to add to the end of array1.

    Returns MetricDefinition[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns MetricDefinition[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, MetricDefinition]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, MetricDefinition]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: MetricDefinition, index: number, array: MetricDefinition[]): boolean
        • Parameters

          • value: MetricDefinition
          • index: number
          • array: MetricDefinition[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: MetricDefinition, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: MetricDefinition

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): MetricDefinition[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: MetricDefinition

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: MetricDefinition, index: number, array: MetricDefinition[]): boolean
        • Parameters

          • value: MetricDefinition
          • index: number
          • array: MetricDefinition[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: MetricDefinition, index: number, array: MetricDefinition[]): any
        • Parameters

          • value: MetricDefinition
          • index: number
          • array: MetricDefinition[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns MetricDefinition[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): MetricDefinition | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: MetricDefinition

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: MetricDefinition, index: number, obj: MetricDefinition[]): boolean
        • Parameters

          • this: void
          • value: MetricDefinition
          • index: number
          • obj: MetricDefinition[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: MetricDefinition, index: number, obj: MetricDefinition[]): boolean
        • Parameters

          • value: MetricDefinition
          • index: number
          • obj: MetricDefinition[]

          Returns boolean

    • Optional thisArg: any

    Returns MetricDefinition | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: MetricDefinition, index: number, obj: MetricDefinition[]): boolean
        • Parameters

          • value: MetricDefinition
          • index: number
          • obj: MetricDefinition[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: MetricDefinition, index: number, array: MetricDefinition[]): void
        • Parameters

          • value: MetricDefinition
          • index: number
          • array: MetricDefinition[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: MetricDefinition, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: MetricDefinition

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: MetricDefinition, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: MetricDefinition

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: MetricDefinition, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: MetricDefinition

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: MetricDefinition, index: number, array: MetricDefinition[]): U
        • Parameters

          • value: MetricDefinition
          • index: number
          • array: MetricDefinition[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): MetricDefinition | undefined
  • Removes the last element from an array and returns it.

    Returns MetricDefinition | undefined

push

  • push(...items: MetricDefinition[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: MetricDefinition[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): MetricDefinition
  • reduce(callbackfn: function, initialValue: MetricDefinition): MetricDefinition
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: MetricDefinition, currentValue: MetricDefinition, currentIndex: number, array: MetricDefinition[]): MetricDefinition
        • Parameters

          • previousValue: MetricDefinition
          • currentValue: MetricDefinition
          • currentIndex: number
          • array: MetricDefinition[]

          Returns MetricDefinition

    Returns MetricDefinition

  • Parameters

    • callbackfn: function
        • (previousValue: MetricDefinition, currentValue: MetricDefinition, currentIndex: number, array: MetricDefinition[]): MetricDefinition
        • Parameters

          • previousValue: MetricDefinition
          • currentValue: MetricDefinition
          • currentIndex: number
          • array: MetricDefinition[]

          Returns MetricDefinition

    • initialValue: MetricDefinition

    Returns MetricDefinition

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: MetricDefinition, currentIndex: number, array: MetricDefinition[]): U
        • Parameters

          • previousValue: U
          • currentValue: MetricDefinition
          • currentIndex: number
          • array: MetricDefinition[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): MetricDefinition
  • reduceRight(callbackfn: function, initialValue: MetricDefinition): MetricDefinition
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: MetricDefinition, currentValue: MetricDefinition, currentIndex: number, array: MetricDefinition[]): MetricDefinition
        • Parameters

          • previousValue: MetricDefinition
          • currentValue: MetricDefinition
          • currentIndex: number
          • array: MetricDefinition[]

          Returns MetricDefinition

    Returns MetricDefinition

  • Parameters

    • callbackfn: function
        • (previousValue: MetricDefinition, currentValue: MetricDefinition, currentIndex: number, array: MetricDefinition[]): MetricDefinition
        • Parameters

          • previousValue: MetricDefinition
          • currentValue: MetricDefinition
          • currentIndex: number
          • array: MetricDefinition[]

          Returns MetricDefinition

    • initialValue: MetricDefinition

    Returns MetricDefinition

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: MetricDefinition, currentIndex: number, array: MetricDefinition[]): U
        • Parameters

          • previousValue: U
          • currentValue: MetricDefinition
          • currentIndex: number
          • array: MetricDefinition[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): MetricDefinition[]
  • Reverses the elements in an Array.

    Returns MetricDefinition[]

shift

  • shift(): MetricDefinition | undefined
  • Removes the first element from an array and returns it.

    Returns MetricDefinition | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): MetricDefinition[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns MetricDefinition[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: MetricDefinition, index: number, array: MetricDefinition[]): boolean
        • Parameters

          • value: MetricDefinition
          • index: number
          • array: MetricDefinition[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): MetricDefinition[]
  • splice(start: number, deleteCount: number, ...items: MetricDefinition[]): MetricDefinition[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns MetricDefinition[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: MetricDefinition[]

      Elements to insert into the array in place of the deleted elements.

    Returns MetricDefinition[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: MetricDefinition[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: MetricDefinition[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<MetricDefinition>
  • Returns an iterable of values in the array

    Returns IterableIterator<MetricDefinition>

type

type: object

className

className: string = "MetricDefinitionList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricDefinition"

name

name: "Composite" = "Composite"

Const MetricDimension

MetricDimension: object
interface

An interface representing MetricDimension. The metric dimension. It indicates the source of the metric.

Optional name

name: undefined | string
member

{string} [name] The metric dimension name.

serializedName

serializedName: string = "MetricDimension"

Optional value

value: undefined | string
member

{string} [value] The metric dimension values.

type

type: object

className

className: string = "MetricDimension"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const MetricFilter

MetricFilter: object
interface

An interface representing MetricFilter. The OData filters to be used for metrics.

category

category: string
member

{string} category Specifies the category of the metrics to be filtered. E.g., "CapacityUtilization". Valid values are the ones returned as the field "category" in the ListMetricDefinitions call. Only 'Equality' operator is supported for this property.

Optional dimensions

dimensions: DimensionFilter
member

{DimensionFilter} [dimensions] Specifies the source(the dimension) of the metrics to be filtered. Only 'Equality' operator is supported for this property.

Optional endTime

endTime: Date
member

{Date} [endTime] Specifies the end time of the time range to be queried. Only 'Less Than Or Equal To' operator is supported for this property.

Optional name

member

{MetricNameFilter} [name] Specifies the metric name filter specifying the name of the metric to be filtered on. Only 'Equality' operator is supported for this property.

serializedName

serializedName: string = "MetricFilter"

Optional startTime

startTime: Date
member

{Date} [startTime] Specifies the start time of the time range to be queried. Only 'Greater Than Or Equal To' operator is supported for this property.

Optional timeGrain

timeGrain: undefined | string
member

{string} [timeGrain] Specifies the time granularity of the metrics to be returned. E.g., "P1D". Valid values are the ones returned as the field "timeGrain" in the ListMetricDefinitions call. Only 'Equality' operator is supported for this property.

type

type: object

className

className: string = "MetricFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

category

category: object

required

required: true = true

serializedName

serializedName: string = "category"

type

type: object

name

name: "String" = "String"

dimensions

dimensions: object

serializedName

serializedName: string = "dimensions"

type

type: object

className

className: string = "DimensionFilter"

name

name: "Composite" = "Composite"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

className

className: string = "MetricNameFilter"

name

name: "Composite" = "Composite"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

timeGrain

timeGrain: object

serializedName

serializedName: string = "timeGrain"

type

type: object

name

name: "String" = "String"

Const MetricList

MetricList: object
interface

An interface representing the MetricList. The metric list.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "MetricList"

__@iterator

  • __@iterator(): IterableIterator<Metrics>
  • Iterator

    Returns IterableIterator<Metrics>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Metrics>[]): Metrics[]
  • concat(...items: (T | ConcatArray<T>)[]): Metrics[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Metrics>[]

      Additional items to add to the end of array1.

    Returns Metrics[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Metrics[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Metrics]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Metrics]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Metrics, index: number, array: Metrics[]): boolean
        • Parameters

          • value: Metrics
          • index: number
          • array: Metrics[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Metrics, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Metrics

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Metrics[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Metrics

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Metrics, index: number, array: Metrics[]): boolean
        • Parameters

          • value: Metrics
          • index: number
          • array: Metrics[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Metrics, index: number, array: Metrics[]): any
        • Parameters

          • value: Metrics
          • index: number
          • array: Metrics[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Metrics[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Metrics | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Metrics

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Metrics, index: number, obj: Metrics[]): boolean
        • Parameters

          • this: void
          • value: Metrics
          • index: number
          • obj: Metrics[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Metrics, index: number, obj: Metrics[]): boolean
        • Parameters

          • value: Metrics
          • index: number
          • obj: Metrics[]

          Returns boolean

    • Optional thisArg: any

    Returns Metrics | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Metrics, index: number, obj: Metrics[]): boolean
        • Parameters

          • value: Metrics
          • index: number
          • obj: Metrics[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Metrics, index: number, array: Metrics[]): void
        • Parameters

          • value: Metrics
          • index: number
          • array: Metrics[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Metrics, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Metrics

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Metrics, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Metrics

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Metrics, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Metrics

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Metrics, index: number, array: Metrics[]): U
        • Parameters

          • value: Metrics
          • index: number
          • array: Metrics[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Metrics | undefined
  • Removes the last element from an array and returns it.

    Returns Metrics | undefined

push

  • push(...items: Metrics[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Metrics[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Metrics
  • reduce(callbackfn: function, initialValue: Metrics): Metrics
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Metrics, currentValue: Metrics, currentIndex: number, array: Metrics[]): Metrics
        • Parameters

          • previousValue: Metrics
          • currentValue: Metrics
          • currentIndex: number
          • array: Metrics[]

          Returns Metrics

    Returns Metrics

  • Parameters

    • callbackfn: function
        • (previousValue: Metrics, currentValue: Metrics, currentIndex: number, array: Metrics[]): Metrics
        • Parameters

          • previousValue: Metrics
          • currentValue: Metrics
          • currentIndex: number
          • array: Metrics[]

          Returns Metrics

    • initialValue: Metrics

    Returns Metrics

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Metrics, currentIndex: number, array: Metrics[]): U
        • Parameters

          • previousValue: U
          • currentValue: Metrics
          • currentIndex: number
          • array: Metrics[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Metrics
  • reduceRight(callbackfn: function, initialValue: Metrics): Metrics
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Metrics, currentValue: Metrics, currentIndex: number, array: Metrics[]): Metrics
        • Parameters

          • previousValue: Metrics
          • currentValue: Metrics
          • currentIndex: number
          • array: Metrics[]

          Returns Metrics

    Returns Metrics

  • Parameters

    • callbackfn: function
        • (previousValue: Metrics, currentValue: Metrics, currentIndex: number, array: Metrics[]): Metrics
        • Parameters

          • previousValue: Metrics
          • currentValue: Metrics
          • currentIndex: number
          • array: Metrics[]

          Returns Metrics

    • initialValue: Metrics

    Returns Metrics

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Metrics, currentIndex: number, array: Metrics[]): U
        • Parameters

          • previousValue: U
          • currentValue: Metrics
          • currentIndex: number
          • array: Metrics[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Metrics[]
  • Reverses the elements in an Array.

    Returns Metrics[]

shift

  • shift(): Metrics | undefined
  • Removes the first element from an array and returns it.

    Returns Metrics | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Metrics[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Metrics[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Metrics, index: number, array: Metrics[]): boolean
        • Parameters

          • value: Metrics
          • index: number
          • array: Metrics[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Metrics[]
  • splice(start: number, deleteCount: number, ...items: Metrics[]): Metrics[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Metrics[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Metrics[]

      Elements to insert into the array in place of the deleted elements.

    Returns Metrics[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Metrics[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Metrics[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Metrics>
  • Returns an iterable of values in the array

    Returns IterableIterator<Metrics>

type

type: object

className

className: string = "MetricList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Metrics"

name

name: "Composite" = "Composite"

Const MetricName

MetricName: object
interface

An interface representing MetricName. The metric name.

Optional localizedValue

localizedValue: undefined | string
member

{string} [localizedValue] The localized metric name.

serializedName

serializedName: string = "MetricName"

Optional value

value: undefined | string
member

{string} [value] The metric name.

type

type: object

className

className: string = "MetricName"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

localizedValue

localizedValue: object

serializedName

serializedName: string = "localizedValue"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const MetricNameFilter

MetricNameFilter: object
interface

An interface representing MetricNameFilter. The metric name filter, specifying the name of the metric to be filtered on.

serializedName

serializedName: string = "MetricNameFilter"

Optional value

value: undefined | string
member

{string} [value] Specifies the metric name to be filtered on. E.g., CloudStorageUsed. Valid values are the ones returned in the field "name" in the ListMetricDefinitions call. Only 'Equality' operator is supported for this property.

type

type: object

className

className: string = "MetricNameFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const Metrics

Metrics: object
interface

An interface representing Metrics. The monitoring metric.

Optional dimensions

dimensions: MetricDimension[]
member

{MetricDimension[]} [dimensions] The metric dimensions.

Optional endTime

endTime: Date
member

{Date} [endTime] The end time of the metric data.

Optional name

member

{MetricName} [name] The name of the metric.

Optional primaryAggregation

primaryAggregation: MetricAggregationType
member

{MetricAggregationType} [primaryAggregation] The metric aggregation type. Possible values include: 'Average', 'Last', 'Maximum', 'Minimum', 'None', 'Total'

Optional resourceId

resourceId: undefined | string
member

{string} [resourceId] The ID of metric source.

serializedName

serializedName: string = "Metrics"

Optional startTime

startTime: Date
member

{Date} [startTime] The start time of the metric data.

Optional timeGrain

timeGrain: undefined | string
member

{string} [timeGrain] The time granularity of the metric data.

Optional unit

member

{MetricUnit} [unit] The unit of the metric data. Possible values include: 'Bytes', 'BytesPerSecond', 'Count', 'CountPerSecond', 'Percent', 'Seconds'

Optional values

values: MetricData[]
member

{MetricData[]} [values] The list of the metric data.

type

type: object
member

{string} [type] The type of the metric data.

className

className: string = "Metrics"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dimensions

dimensions: object

serializedName

serializedName: string = "dimensions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricDimension"

name

name: "Composite" = "Composite"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

className

className: string = "MetricName"

name

name: "Composite" = "Composite"

primaryAggregation

primaryAggregation: object

serializedName

serializedName: string = "primaryAggregation"

type

type: object

allowedValues

allowedValues: string[] = ["Average","Last","Maximum","Minimum","None","Total"]

name

name: "Enum" = "Enum"

resourceId

resourceId: object

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

timeGrain

timeGrain: object

serializedName

serializedName: string = "timeGrain"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

unit

unit: object

serializedName

serializedName: string = "unit"

type

type: object

allowedValues

allowedValues: string[] = ["Bytes","BytesPerSecond","Count","CountPerSecond","Percent","Seconds"]

name

name: "Enum" = "Enum"

values

values: object

serializedName

serializedName: string = "values"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricData"

name

name: "Composite" = "Composite"

Const NetworkAdapterList

NetworkAdapterList: object
interface

An interface representing NetworkAdapterList. The collection of network adapters on the device.

serializedName

serializedName: string = "NetworkAdapterList"

value

value: NetworkAdapters[]
member

{NetworkAdapters[]} value The value.

type

type: object

className

className: string = "NetworkAdapterList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkAdapters"

name

name: "Composite" = "Composite"

Const NetworkAdapters

NetworkAdapters: object
interface

An interface representing NetworkAdapters. Represents the network adapter on device.

interfaceId

interfaceId: NetInterfaceId
member

{NetInterfaceId} interfaceId The ID of the network adapter. Possible values include: 'Invalid', 'Data0', 'Data1', 'Data2', 'Data3', 'Data4', 'Data5'

Optional isDefault

isDefault: undefined | false | true
member

{boolean} [isDefault] Value indicating whether this instance is default.

iscsiAndCloudStatus

iscsiAndCloudStatus: ISCSIAndCloudStatus
member

{ISCSIAndCloudStatus} iscsiAndCloudStatus Value indicating cloud and ISCSI status of network adapter. Possible values include: 'Disabled', 'IscsiEnabled', 'CloudEnabled', 'IscsiAndCloudEnabled'

mode

member

{NetworkMode} mode The mode of network adapter, either IPv4, IPv6 or both. Possible values include: 'Invalid', 'IPV4', 'IPV6', 'BOTH'

netInterfaceStatus

netInterfaceStatus: NetInterfaceStatus
member

{NetInterfaceStatus} netInterfaceStatus Value indicating status of network adapter. Possible values include: 'Enabled', 'Disabled'

Optional nicIpv4Settings

nicIpv4Settings: NicIPv4
member

{NicIPv4} [nicIpv4Settings] The IPv4 configuration of the network adapter.

Optional nicIpv6Settings

nicIpv6Settings: NicIPv6
member

{NicIPv6} [nicIpv6Settings] The IPv6 configuration of the network adapter.

serializedName

serializedName: string = "NetworkAdapters"

Optional speed

speed: undefined | number
member

{number} [speed] The speed of the network adapter.

type

type: object

className

className: string = "NetworkAdapters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

interfaceId

interfaceId: object

required

required: true = true

serializedName

serializedName: string = "interfaceId"

type

type: object

allowedValues

allowedValues: string[] = ["Invalid","Data0","Data1","Data2","Data3","Data4","Data5"]

name

name: "Enum" = "Enum"

isDefault

isDefault: object

serializedName

serializedName: string = "isDefault"

type

type: object

name

name: "Boolean" = "Boolean"

iscsiAndCloudStatus

iscsiAndCloudStatus: object

required

required: true = true

serializedName

serializedName: string = "iscsiAndCloudStatus"

type

type: object

allowedValues

allowedValues: string[] = ["Disabled","IscsiEnabled","CloudEnabled","IscsiAndCloudEnabled"]

name

name: "Enum" = "Enum"

mode

mode: object

required

required: true = true

serializedName

serializedName: string = "mode"

type

type: object

allowedValues

allowedValues: string[] = ["Invalid","IPV4","IPV6","BOTH"]

name

name: "Enum" = "Enum"

netInterfaceStatus

netInterfaceStatus: object

required

required: true = true

serializedName

serializedName: string = "netInterfaceStatus"

type

type: object

allowedValues

allowedValues: string[] = ["Enabled","Disabled"]

name

name: "Enum" = "Enum"

nicIpv4Settings

nicIpv4Settings: object

serializedName

serializedName: string = "nicIpv4Settings"

type

type: object

className

className: string = "NicIPv4"

name

name: "Composite" = "Composite"

nicIpv6Settings

nicIpv6Settings: object

serializedName

serializedName: string = "nicIpv6Settings"

type

type: object

className

className: string = "NicIPv6"

name

name: "Composite" = "Composite"

speed

speed: object

serializedName

serializedName: string = "speed"

type

type: object

name

name: "Number" = "Number"

Const NetworkInterfaceData0Settings

NetworkInterfaceData0Settings: object
interface

An interface representing NetworkInterfaceData0Settings. The 'Data 0' network interface card settings.

Optional controllerOneIp

controllerOneIp: undefined | string
member

{string} [controllerOneIp] The controller 1's IPv4 address.

Optional controllerZeroIp

controllerZeroIp: undefined | string
member

{string} [controllerZeroIp] The controller 0's IPv4 address.

serializedName

serializedName: string = "NetworkInterfaceData0Settings"

type

type: object

className

className: string = "NetworkInterfaceData0Settings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

controllerOneIp

controllerOneIp: object

serializedName

serializedName: string = "controllerOneIp"

type

type: object

name

name: "String" = "String"

controllerZeroIp

controllerZeroIp: object

serializedName

serializedName: string = "controllerZeroIp"

type

type: object

name

name: "String" = "String"

Const NetworkSettings

NetworkSettings: object
interface

An interface representing NetworkSettings. Represents the network settings of a device.

extends

BaseModel

dnsSettings

dnsSettings: DNSSettings
member

{DNSSettings} dnsSettings The DNS (Domain Name System) settings of device.

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

networkAdapters

networkAdapters: NetworkAdapterList
member

{NetworkAdapterList} networkAdapters The network adapter list of device.

serializedName

serializedName: string = "NetworkSettings"

webproxySettings

webproxySettings: WebproxySettings
member

{WebproxySettings} webproxySettings The webproxy settings of device.

type

type: object

className

className: string = "NetworkSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dnsSettings

dnsSettings: object

required

required: true = true

serializedName

serializedName: string = "properties.dnsSettings"

type

type: object

className

className: string = "DNSSettings"

name

name: "Composite" = "Composite"

networkAdapters

networkAdapters: object

required

required: true = true

serializedName

serializedName: string = "properties.networkAdapters"

type

type: object

className

className: string = "NetworkAdapterList"

name

name: "Composite" = "Composite"

webproxySettings

webproxySettings: object

required

required: true = true

serializedName

serializedName: string = "properties.webproxySettings"

type

type: object

className

className: string = "WebproxySettings"

name

name: "Composite" = "Composite"

Const NetworkSettingsPatch

NetworkSettingsPatch: object
interface

An interface representing NetworkSettingsPatch. Represents the patch request for the network settings of a device.

Optional dnsSettings

dnsSettings: DNSSettings
member

{DNSSettings} [dnsSettings] The DNS (Domain Name System) settings of device.

Optional networkAdapters

networkAdapters: NetworkAdapterList
member

{NetworkAdapterList} [networkAdapters] The network adapter list of device.

serializedName

serializedName: string = "NetworkSettingsPatch"

type

type: object

className

className: string = "NetworkSettingsPatch"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dnsSettings

dnsSettings: object

serializedName

serializedName: string = "properties.dnsSettings"

type

type: object

className

className: string = "DNSSettings"

name

name: "Composite" = "Composite"

networkAdapters

networkAdapters: object

serializedName

serializedName: string = "properties.networkAdapters"

type

type: object

className

className: string = "NetworkAdapterList"

name

name: "Composite" = "Composite"

Const NicIPv4

NicIPv4: object
interface

An interface representing NicIPv4. Details related to the IPv4 address configuration.

Optional controller0Ipv4Address

controller0Ipv4Address: undefined | string
member

{string} [controller0Ipv4Address] The IPv4 address of Controller0.

Optional controller1Ipv4Address

controller1Ipv4Address: undefined | string
member

{string} [controller1Ipv4Address] The IPv4 address of Controller1.

Optional ipv4Address

ipv4Address: undefined | string
member

{string} [ipv4Address] The IPv4 address of the network adapter.

Optional ipv4Gateway

ipv4Gateway: undefined | string
member

{string} [ipv4Gateway] The IPv4 gateway of the network adapter.

Optional ipv4Netmask

ipv4Netmask: undefined | string
member

{string} [ipv4Netmask] The IPv4 netmask of the network adapter.

serializedName

serializedName: string = "NicIPv4"

type

type: object

className

className: string = "NicIPv4"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

controller0Ipv4Address

controller0Ipv4Address: object

serializedName

serializedName: string = "controller0Ipv4Address"

type

type: object

name

name: "String" = "String"

controller1Ipv4Address

controller1Ipv4Address: object

serializedName

serializedName: string = "controller1Ipv4Address"

type

type: object

name

name: "String" = "String"

ipv4Address

ipv4Address: object

serializedName

serializedName: string = "ipv4Address"

type

type: object

name

name: "String" = "String"

ipv4Gateway

ipv4Gateway: object

serializedName

serializedName: string = "ipv4Gateway"

type

type: object

name

name: "String" = "String"

ipv4Netmask

ipv4Netmask: object

serializedName

serializedName: string = "ipv4Netmask"

type

type: object

name

name: "String" = "String"

Const NicIPv6

NicIPv6: object
interface

An interface representing NicIPv6. Details related to the IPv6 address configuration.

Optional controller0Ipv6Address

controller0Ipv6Address: undefined | string
member

{string} [controller0Ipv6Address] The IPv6 address of Controller0.

Optional controller1Ipv6Address

controller1Ipv6Address: undefined | string
member

{string} [controller1Ipv6Address] The IPv6 address of Controller1.

Optional ipv6Address

ipv6Address: undefined | string
member

{string} [ipv6Address] The IPv6 address of the network adapter.

Optional ipv6Gateway

ipv6Gateway: undefined | string
member

{string} [ipv6Gateway] The IPv6 gateway of the network adapter.

Optional ipv6Prefix

ipv6Prefix: undefined | string
member

{string} [ipv6Prefix] The IPv6 prefix of the network adapter.

serializedName

serializedName: string = "NicIPv6"

type

type: object

className

className: string = "NicIPv6"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

controller0Ipv6Address

controller0Ipv6Address: object

serializedName

serializedName: string = "controller0Ipv6Address"

type

type: object

name

name: "String" = "String"

controller1Ipv6Address

controller1Ipv6Address: object

serializedName

serializedName: string = "controller1Ipv6Address"

type

type: object

name

name: "String" = "String"

ipv6Address

ipv6Address: object

serializedName

serializedName: string = "ipv6Address"

type

type: object

name

name: "String" = "String"

ipv6Gateway

ipv6Gateway: object

serializedName

serializedName: string = "ipv6Gateway"

type

type: object

name

name: "String" = "String"

ipv6Prefix

ipv6Prefix: object

serializedName

serializedName: string = "ipv6Prefix"

type

type: object

name

name: "String" = "String"

Const PublicKey

PublicKey: object
interface

An interface representing PublicKey. The public key.

key

key: string
member

{string} key The key.

serializedName

serializedName: string = "PublicKey"

type

type: object

className

className: string = "PublicKey"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

key

key: object

required

required: true = true

serializedName

serializedName: string = "key"

type

type: object

name

name: "String" = "String"

Const RemoteManagementSettings

RemoteManagementSettings: object
interface

An interface representing RemoteManagementSettings. The settings for remote management of a device.

Optional remoteManagementCertificate

remoteManagementCertificate: undefined | string
member

{string} [remoteManagementCertificate] The remote management certificates.

remoteManagementMode

remoteManagementMode: RemoteManagementModeConfiguration
member

{RemoteManagementModeConfiguration} remoteManagementMode The remote management mode. Possible values include: 'Unknown', 'Disabled', 'HttpsEnabled', 'HttpsAndHttpEnabled'

serializedName

serializedName: string = "RemoteManagementSettings"

type

type: object

className

className: string = "RemoteManagementSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

remoteManagementCertificate

remoteManagementCertificate: object

serializedName

serializedName: string = "remoteManagementCertificate"

type

type: object

name

name: "String" = "String"

remoteManagementMode

remoteManagementMode: object

required

required: true = true

serializedName

serializedName: string = "remoteManagementMode"

type

type: object

allowedValues

allowedValues: string[] = ["Unknown","Disabled","HttpsEnabled","HttpsAndHttpEnabled"]

name

name: "Enum" = "Enum"

Const RemoteManagementSettingsPatch

RemoteManagementSettingsPatch: object
interface

An interface representing RemoteManagementSettingsPatch. The settings for updating remote management mode of the device.

remoteManagementMode

remoteManagementMode: RemoteManagementModeConfiguration
member

{RemoteManagementModeConfiguration} remoteManagementMode The remote management mode. Possible values include: 'Unknown', 'Disabled', 'HttpsEnabled', 'HttpsAndHttpEnabled'

serializedName

serializedName: string = "RemoteManagementSettingsPatch"

type

type: object

className

className: string = "RemoteManagementSettingsPatch"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

remoteManagementMode

remoteManagementMode: object

required

required: true = true

serializedName

serializedName: string = "remoteManagementMode"

type

type: object

allowedValues

allowedValues: string[] = ["Unknown","Disabled","HttpsEnabled","HttpsAndHttpEnabled"]

name

name: "Enum" = "Enum"

Const Resource

Resource: object
interface

An interface representing Resource. The Azure Resource.

extends

BaseResource

Optional id

id: undefined | string
member

{string} [id] The resource ID. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string
member

{string} location The geo location of the resource.

Optional name

name: undefined | string
member

{string} [name] The resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Resource"

Optional tags

tags: undefined | object
member

{{ [propertyName: string]: string }} [tags] The tags attached to the resource.

type

type: object
member

{string} [type] The resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Resource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

location

location: object

required

required: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ScheduleRecurrence

ScheduleRecurrence: object
interface

An interface representing ScheduleRecurrence. The schedule recurrence.

recurrenceType

recurrenceType: RecurrenceType
member

{RecurrenceType} recurrenceType The recurrence type. Possible values include: 'Minutes', 'Hourly', 'Daily', 'Weekly'

recurrenceValue

recurrenceValue: number
member

{number} recurrenceValue The recurrence value.

serializedName

serializedName: string = "ScheduleRecurrence"

Optional weeklyDaysList

weeklyDaysList: DayOfWeek[]
member

{DayOfWeek[]} [weeklyDaysList] The week days list. Applicable only for schedules of recurrence type 'weekly'.

type

type: object

className

className: string = "ScheduleRecurrence"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

recurrenceType

recurrenceType: object

required

required: true = true

serializedName

serializedName: string = "recurrenceType"

type

type: object

allowedValues

allowedValues: string[] = ["Minutes","Hourly","Daily","Weekly"]

name

name: "Enum" = "Enum"

recurrenceValue

recurrenceValue: object

required

required: true = true

serializedName

serializedName: string = "recurrenceValue"

type

type: object

name

name: "Number" = "Number"

weeklyDaysList

weeklyDaysList: object

serializedName

serializedName: string = "weeklyDaysList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]

name

name: "Enum" = "Enum"

Const SecondaryDNSSettings

SecondaryDNSSettings: object
interface

An interface representing SecondaryDNSSettings. The secondary DNS settings.

Optional secondaryDnsServers

secondaryDnsServers: string[]
member

{string[]} [secondaryDnsServers] The list of secondary DNS Server IP addresses.

serializedName

serializedName: string = "SecondaryDNSSettings"

type

type: object

className

className: string = "SecondaryDNSSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

secondaryDnsServers

secondaryDnsServers: object

serializedName

serializedName: string = "secondaryDnsServers"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const SecuritySettings

SecuritySettings: object
interface

An interface representing SecuritySettings. The security settings of a device.

extends

BaseModel

chapSettings

chapSettings: ChapSettings
member

{ChapSettings} chapSettings The Challenge-Handshake Authentication Protocol (CHAP) settings.

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

remoteManagementSettings

remoteManagementSettings: RemoteManagementSettings
member

{RemoteManagementSettings} remoteManagementSettings The settings for remote management of a device.

serializedName

serializedName: string = "SecuritySettings"

type

type: object

className

className: string = "SecuritySettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

chapSettings

chapSettings: object

required

required: true = true

serializedName

serializedName: string = "properties.chapSettings"

type

type: object

className

className: string = "ChapSettings"

name

name: "Composite" = "Composite"

remoteManagementSettings

remoteManagementSettings: object

required

required: true = true

serializedName

serializedName: string = "properties.remoteManagementSettings"

type

type: object

className

className: string = "RemoteManagementSettings"

name

name: "Composite" = "Composite"

Const SecuritySettingsPatch

SecuritySettingsPatch: object
interface

An interface representing SecuritySettingsPatch. Represents the patch request for the security settings of a device.

Optional chapSettings

chapSettings: ChapSettings
member

{ChapSettings} [chapSettings] The device CHAP and reverse-CHAP settings.

Optional cloudApplianceSettings

cloudApplianceSettings: CloudApplianceSettings
member

{CloudApplianceSettings} [cloudApplianceSettings] The cloud appliance settings.

Optional deviceAdminPassword

deviceAdminPassword: AsymmetricEncryptedSecret
member

{AsymmetricEncryptedSecret} [deviceAdminPassword] The device administrator password.

Optional remoteManagementSettings

remoteManagementSettings: RemoteManagementSettingsPatch
member

{RemoteManagementSettingsPatch} [remoteManagementSettings] The remote management settings.

serializedName

serializedName: string = "SecuritySettingsPatch"

Optional snapshotPassword

snapshotPassword: AsymmetricEncryptedSecret
member

{AsymmetricEncryptedSecret} [snapshotPassword] The snapshot manager password.

type

type: object

className

className: string = "SecuritySettingsPatch"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

chapSettings

chapSettings: object

serializedName

serializedName: string = "properties.chapSettings"

type

type: object

className

className: string = "ChapSettings"

name

name: "Composite" = "Composite"

cloudApplianceSettings

cloudApplianceSettings: object

serializedName

serializedName: string = "properties.cloudApplianceSettings"

type

type: object

className

className: string = "CloudApplianceSettings"

name

name: "Composite" = "Composite"

deviceAdminPassword

deviceAdminPassword: object

serializedName

serializedName: string = "properties.deviceAdminPassword"

type

type: object

className

className: string = "AsymmetricEncryptedSecret"

name

name: "Composite" = "Composite"

remoteManagementSettings

remoteManagementSettings: object

serializedName

serializedName: string = "properties.remoteManagementSettings"

type

type: object

className

className: string = "RemoteManagementSettingsPatch"

name

name: "Composite" = "Composite"

snapshotPassword

snapshotPassword: object

serializedName

serializedName: string = "properties.snapshotPassword"

type

type: object

className

className: string = "AsymmetricEncryptedSecret"

name

name: "Composite" = "Composite"

Const SendTestAlertEmailRequest

SendTestAlertEmailRequest: object
interface

An interface representing SendTestAlertEmailRequest. The request for sending test alert email

emailList

emailList: string[]
member

{string[]} emailList The list of email IDs to send the test alert email

serializedName

serializedName: string = "SendTestAlertEmailRequest"

type

type: object

className

className: string = "SendTestAlertEmailRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

emailList

emailList: object

required

required: true = true

serializedName

serializedName: string = "emailList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const StorageAccountCredential

StorageAccountCredential: object
interface

An interface representing StorageAccountCredential. The storage account credential.

extends

BaseModel

Optional accessKey

member

{AsymmetricEncryptedSecret} [accessKey] The details of the storage account password.

endPoint

endPoint: string
member

{string} endPoint The storage endpoint

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "StorageAccountCredential"

sslStatus

sslStatus: SslStatus
member

{SslStatus} sslStatus Signifies whether SSL needs to be enabled or not. Possible values include: 'Enabled', 'Disabled'

Optional volumesCount

volumesCount: undefined | number
member

{number} [volumesCount] The count of volumes using this storage account credential. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "StorageAccountCredential"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

accessKey

accessKey: object

serializedName

serializedName: string = "properties.accessKey"

type

type: object

className

className: string = "AsymmetricEncryptedSecret"

name

name: "Composite" = "Composite"

endPoint

endPoint: object

required

required: true = true

serializedName

serializedName: string = "properties.endPoint"

type

type: object

name

name: "String" = "String"

sslStatus

sslStatus: object

required

required: true = true

serializedName

serializedName: string = "properties.sslStatus"

type

type: object

allowedValues

allowedValues: string[] = ["Enabled","Disabled"]

name

name: "Enum" = "Enum"

volumesCount

volumesCount: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.volumesCount"

type

type: object

name

name: "Number" = "Number"

Const StorageAccountCredentialList

StorageAccountCredentialList: object
interface

An interface representing the StorageAccountCredentialList. The collection of storage account credential entities.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "StorageAccountCredentialList"

__@iterator

  • __@iterator(): IterableIterator<StorageAccountCredential>
  • Iterator

    Returns IterableIterator<StorageAccountCredential>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<StorageAccountCredential>[]): StorageAccountCredential[]
  • concat(...items: (T | ConcatArray<T>)[]): StorageAccountCredential[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<StorageAccountCredential>[]

      Additional items to add to the end of array1.

    Returns StorageAccountCredential[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns StorageAccountCredential[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, StorageAccountCredential]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, StorageAccountCredential]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: StorageAccountCredential, index: number, array: StorageAccountCredential[]): boolean
        • Parameters

          • value: StorageAccountCredential
          • index: number
          • array: StorageAccountCredential[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: StorageAccountCredential, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: StorageAccountCredential

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): StorageAccountCredential[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: StorageAccountCredential

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: StorageAccountCredential, index: number, array: StorageAccountCredential[]): boolean
        • Parameters

          • value: StorageAccountCredential
          • index: number
          • array: StorageAccountCredential[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: StorageAccountCredential, index: number, array: StorageAccountCredential[]): any
        • Parameters

          • value: StorageAccountCredential
          • index: number
          • array: StorageAccountCredential[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns StorageAccountCredential[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): StorageAccountCredential | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: StorageAccountCredential

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: StorageAccountCredential, index: number, obj: StorageAccountCredential[]): boolean
        • Parameters

          • this: void
          • value: StorageAccountCredential
          • index: number
          • obj: StorageAccountCredential[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: StorageAccountCredential, index: number, obj: StorageAccountCredential[]): boolean
        • Parameters

          • value: StorageAccountCredential
          • index: number
          • obj: StorageAccountCredential[]

          Returns boolean

    • Optional thisArg: any

    Returns StorageAccountCredential | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: StorageAccountCredential, index: number, obj: StorageAccountCredential[]): boolean
        • Parameters

          • value: StorageAccountCredential
          • index: number
          • obj: StorageAccountCredential[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: StorageAccountCredential, index: number, array: StorageAccountCredential[]): void
        • Parameters

          • value: StorageAccountCredential
          • index: number
          • array: StorageAccountCredential[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: StorageAccountCredential, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: StorageAccountCredential

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: StorageAccountCredential, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: StorageAccountCredential

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: StorageAccountCredential, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: StorageAccountCredential

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: StorageAccountCredential, index: number, array: StorageAccountCredential[]): U
        • Parameters

          • value: StorageAccountCredential
          • index: number
          • array: StorageAccountCredential[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): StorageAccountCredential | undefined
  • Removes the last element from an array and returns it.

    Returns StorageAccountCredential | undefined

push

  • push(...items: StorageAccountCredential[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: StorageAccountCredential[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): StorageAccountCredential
  • reduce(callbackfn: function, initialValue: StorageAccountCredential): StorageAccountCredential
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: StorageAccountCredential, currentValue: StorageAccountCredential, currentIndex: number, array: StorageAccountCredential[]): StorageAccountCredential
        • Parameters

          • previousValue: StorageAccountCredential
          • currentValue: StorageAccountCredential
          • currentIndex: number
          • array: StorageAccountCredential[]

          Returns StorageAccountCredential

    Returns StorageAccountCredential

  • Parameters

    • callbackfn: function
        • (previousValue: StorageAccountCredential, currentValue: StorageAccountCredential, currentIndex: number, array: StorageAccountCredential[]): StorageAccountCredential
        • Parameters

          • previousValue: StorageAccountCredential
          • currentValue: StorageAccountCredential
          • currentIndex: number
          • array: StorageAccountCredential[]

          Returns StorageAccountCredential

    • initialValue: StorageAccountCredential

    Returns StorageAccountCredential

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: StorageAccountCredential, currentIndex: number, array: StorageAccountCredential[]): U
        • Parameters

          • previousValue: U
          • currentValue: StorageAccountCredential
          • currentIndex: number
          • array: StorageAccountCredential[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): StorageAccountCredential
  • reduceRight(callbackfn: function, initialValue: StorageAccountCredential): StorageAccountCredential
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: StorageAccountCredential, currentValue: StorageAccountCredential, currentIndex: number, array: StorageAccountCredential[]): StorageAccountCredential
        • Parameters

          • previousValue: StorageAccountCredential
          • currentValue: StorageAccountCredential
          • currentIndex: number
          • array: StorageAccountCredential[]

          Returns StorageAccountCredential

    Returns StorageAccountCredential

  • Parameters

    • callbackfn: function
        • (previousValue: StorageAccountCredential, currentValue: StorageAccountCredential, currentIndex: number, array: StorageAccountCredential[]): StorageAccountCredential
        • Parameters

          • previousValue: StorageAccountCredential
          • currentValue: StorageAccountCredential
          • currentIndex: number
          • array: StorageAccountCredential[]

          Returns StorageAccountCredential

    • initialValue: StorageAccountCredential

    Returns StorageAccountCredential

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: StorageAccountCredential, currentIndex: number, array: StorageAccountCredential[]): U
        • Parameters

          • previousValue: U
          • currentValue: StorageAccountCredential
          • currentIndex: number
          • array: StorageAccountCredential[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): StorageAccountCredential[]
  • Reverses the elements in an Array.

    Returns StorageAccountCredential[]

shift

  • shift(): StorageAccountCredential | undefined
  • Removes the first element from an array and returns it.

    Returns StorageAccountCredential | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): StorageAccountCredential[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns StorageAccountCredential[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: StorageAccountCredential, index: number, array: StorageAccountCredential[]): boolean
        • Parameters

          • value: StorageAccountCredential
          • index: number
          • array: StorageAccountCredential[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): StorageAccountCredential[]
  • splice(start: number, deleteCount: number, ...items: StorageAccountCredential[]): StorageAccountCredential[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns StorageAccountCredential[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: StorageAccountCredential[]

      Elements to insert into the array in place of the deleted elements.

    Returns StorageAccountCredential[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: StorageAccountCredential[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: StorageAccountCredential[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<StorageAccountCredential>
  • Returns an iterable of values in the array

    Returns IterableIterator<StorageAccountCredential>

type

type: object

className

className: string = "StorageAccountCredentialList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "StorageAccountCredential"

name

name: "Composite" = "Composite"

Const SymmetricEncryptedSecret

SymmetricEncryptedSecret: object
interface

An interface representing SymmetricEncryptedSecret. Represents the secrets encrypted using Symmetric Encryption Key.

encryptionAlgorithm

encryptionAlgorithm: EncryptionAlgorithm
member

{EncryptionAlgorithm} encryptionAlgorithm The algorithm used to encrypt the "Value". Possible values include: 'None', 'AES256', 'RSAES_PKCS1_v_1_5'

serializedName

serializedName: string = "SymmetricEncryptedSecret"

value

value: string
member

{string} value The value of the secret itself. If the secret is in plaintext or null then EncryptionAlgorithm will be none.

Optional valueCertificateThumbprint

valueCertificateThumbprint: undefined | string
member

{string} [valueCertificateThumbprint] The thumbprint of the cert that was used to encrypt "Value".

type

type: object

className

className: string = "SymmetricEncryptedSecret"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

encryptionAlgorithm

encryptionAlgorithm: object

required

required: true = true

serializedName

serializedName: string = "encryptionAlgorithm"

type

type: object

allowedValues

allowedValues: string[] = ["None","AES256","RSAES_PKCS1_v_1_5"]

name

name: "Enum" = "Enum"

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

valueCertificateThumbprint

valueCertificateThumbprint: object

serializedName

serializedName: string = "valueCertificateThumbprint"

type

type: object

name

name: "String" = "String"

Const TargetEligibilityErrorMessage

TargetEligibilityErrorMessage: object
interface

An interface representing TargetEligibilityErrorMessage. The error/warning message due to which the device is ineligible as a failover target device.

Optional message

message: undefined | string
member

{string} [message] The localized error message stating the reason why the device is not eligible as a target device.

Optional resolution

resolution: undefined | string
member

{string} [resolution] The localized resolution message for the error.

Optional resultCode

member

{TargetEligibilityResultCode} [resultCode] The result code for the error, due to which the device does not qualify as a failover target device. Possible values include: 'TargetAndSourceCannotBeSameError', 'TargetIsNotOnlineError', 'TargetSourceIncompatibleVersionError', 'LocalToTieredVolumesConversionWarning', 'TargetInsufficientCapacityError', 'TargetInsufficientLocalVolumeMemoryError', 'TargetInsufficientTieredVolumeMemoryError'

serializedName

serializedName: string = "TargetEligibilityErrorMessage"

type

type: object

className

className: string = "TargetEligibilityErrorMessage"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

resolution

resolution: object

serializedName

serializedName: string = "resolution"

type

type: object

name

name: "String" = "String"

resultCode

resultCode: object

serializedName

serializedName: string = "resultCode"

type

type: object

allowedValues

allowedValues: string[] = ["TargetAndSourceCannotBeSameError","TargetIsNotOnlineError","TargetSourceIncompatibleVersionError","LocalToTieredVolumesConversionWarning","TargetInsufficientCapacityError","TargetInsufficientLocalVolumeMemoryError","TargetInsufficientTieredVolumeMemoryError"]

name

name: "Enum" = "Enum"

Const TargetEligibilityResult

TargetEligibilityResult: object
interface

An interface representing TargetEligibilityResult. The eligibility result of device, as a failover target device.

Optional eligibilityStatus

eligibilityStatus: TargetEligibilityStatus
member

{TargetEligibilityStatus} [eligibilityStatus] The eligibility status of device, as a failover target device. Possible values include: 'NotEligible', 'Eligible'

Optional messages

messages: TargetEligibilityErrorMessage[]
member

{TargetEligibilityErrorMessage[]} [messages] The list of error messages, if a device does not qualify as a failover target device.

serializedName

serializedName: string = "TargetEligibilityResult"

type

type: object

className

className: string = "TargetEligibilityResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

eligibilityStatus

eligibilityStatus: object

serializedName

serializedName: string = "eligibilityStatus"

type

type: object

allowedValues

allowedValues: string[] = ["NotEligible","Eligible"]

name

name: "Enum" = "Enum"

messages

messages: object

serializedName

serializedName: string = "messages"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TargetEligibilityErrorMessage"

name

name: "Composite" = "Composite"

Const Time

Time: object
interface

An interface representing Time. The time.

hours

hours: number
member

{number} hours The hour.

minutes

minutes: number
member

{number} minutes The minute.

seconds

seconds: number
member

{number} seconds The second.

serializedName

serializedName: string = "Time"

type

type: object

className

className: string = "Time"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

hours

hours: object

required

required: true = true

serializedName

serializedName: string = "hours"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 23

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

minutes

minutes: object

required

required: true = true

serializedName

serializedName: string = "minutes"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 59

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

seconds

seconds: object

required

required: true = true

serializedName

serializedName: string = "seconds"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 59

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

Const TimeSettings

TimeSettings: object
interface

An interface representing TimeSettings. The time settings of a device.

extends

BaseModel

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional primaryTimeServer

primaryTimeServer: undefined | string
member

{string} [primaryTimeServer] The primary Network Time Protocol (NTP) server name, like 'time.windows.com'.

Optional secondaryTimeServer

secondaryTimeServer: string[]
member

{string[]} [secondaryTimeServer] The secondary Network Time Protocol (NTP) server name, like 'time.contoso.com'. It's optional.

serializedName

serializedName: string = "TimeSettings"

timeZone

timeZone: string
member

{string} timeZone The timezone of device, like '(UTC -06:00) Central America'

type

type: object

className

className: string = "TimeSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

primaryTimeServer

primaryTimeServer: object

serializedName

serializedName: string = "properties.primaryTimeServer"

type

type: object

name

name: "String" = "String"

secondaryTimeServer

secondaryTimeServer: object

serializedName

serializedName: string = "properties.secondaryTimeServer"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

timeZone

timeZone: object

required

required: true = true

serializedName

serializedName: string = "properties.timeZone"

type

type: object

name

name: "String" = "String"

Const Updates

Updates: object
interface

An interface representing Updates. The updates profile of a device.

extends

BaseModel

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isUpdateInProgress

isUpdateInProgress: undefined | false | true
member

{boolean} [isUpdateInProgress] Indicates whether an update is in progress or not.

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

Optional lastUpdatedTime

lastUpdatedTime: Date
member

{Date} [lastUpdatedTime] The time when the last update was completed.

Optional maintenanceModeUpdatesAvailable

maintenanceModeUpdatesAvailable: undefined | false | true
member

{boolean} [maintenanceModeUpdatesAvailable] Set to 'true' if maintenance mode update available.

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional regularUpdatesAvailable

regularUpdatesAvailable: undefined | false | true
member

{boolean} [regularUpdatesAvailable] Set to 'true' if regular updates are available for the device.

serializedName

serializedName: string = "Updates"

type

type: object

className

className: string = "Updates"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

isUpdateInProgress

isUpdateInProgress: object

serializedName

serializedName: string = "properties.isUpdateInProgress"

type

type: object

name

name: "Boolean" = "Boolean"

lastUpdatedTime

lastUpdatedTime: object

serializedName

serializedName: string = "properties.lastUpdatedTime"

type

type: object

name

name: "DateTime" = "DateTime"

maintenanceModeUpdatesAvailable

maintenanceModeUpdatesAvailable: object

serializedName

serializedName: string = "properties.maintenanceModeUpdatesAvailable"

type

type: object

name

name: "Boolean" = "Boolean"

regularUpdatesAvailable

regularUpdatesAvailable: object

serializedName

serializedName: string = "properties.regularUpdatesAvailable"

type

type: object

name

name: "Boolean" = "Boolean"

Const VmImage

VmImage: object
interface

An interface representing VmImage. The virtual machine image.

name

name: string
member

{string} name The name.

offer

offer: string
member

{string} offer The offer.

publisher

publisher: string
member

{string} publisher The publisher.

serializedName

serializedName: string = "VmImage"

sku

sku: string
member

{string} sku The SKU.

version

version: string
member

{string} version The version.

type

type: object

className

className: string = "VmImage"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

offer

offer: object

required

required: true = true

serializedName

serializedName: string = "offer"

type

type: object

name

name: "String" = "String"

publisher

publisher: object

required

required: true = true

serializedName

serializedName: string = "publisher"

type

type: object

name

name: "String" = "String"

sku

sku: object

required

required: true = true

serializedName

serializedName: string = "sku"

type

type: object

name

name: "String" = "String"

version

version: object

required

required: true = true

serializedName

serializedName: string = "version"

type

type: object

name

name: "String" = "String"

Const Volume

Volume: object
interface

An interface representing Volume. The volume.

extends

BaseModel

accessControlRecordIds

accessControlRecordIds: string[]
member

{string[]} accessControlRecordIds The IDs of the access control records, associated with the volume.

Optional backupPolicyIds

backupPolicyIds: string[]
member

{string[]} [backupPolicyIds] The IDs of the backup policies, in which this volume is part of. NOTE: This property will not be serialized. It can only be populated by the server.

Optional backupStatus

backupStatus: BackupStatus
member

{BackupStatus} [backupStatus] The backup status of the volume. Possible values include: 'Enabled', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

monitoringStatus

monitoringStatus: MonitoringStatus
member

{MonitoringStatus} monitoringStatus The monitoring status of the volume. Possible values include: 'Enabled', 'Disabled'

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional operationStatus

operationStatus: OperationStatus
member

{OperationStatus} [operationStatus] The operation status on the volume. Possible values include: 'None', 'Updating', 'Deleting', 'Restoring' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Volume"

sizeInBytes

sizeInBytes: number
member

{number} sizeInBytes The size of the volume in bytes.

Optional volumeContainerId

volumeContainerId: undefined | string
member

{string} [volumeContainerId] The ID of the volume container, in which this volume is created. NOTE: This property will not be serialized. It can only be populated by the server.

volumeStatus

volumeStatus: VolumeStatus
member

{VolumeStatus} volumeStatus The volume status. Possible values include: 'Online', 'Offline'

volumeType

volumeType: VolumeType
member

{VolumeType} volumeType The type of the volume. Possible values include: 'Tiered', 'Archival', 'LocallyPinned'

type

type: object

className

className: string = "Volume"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

accessControlRecordIds

accessControlRecordIds: object

required

required: true = true

serializedName

serializedName: string = "properties.accessControlRecordIds"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

backupPolicyIds

backupPolicyIds: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.backupPolicyIds"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

backupStatus

backupStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.backupStatus"

type

type: object

allowedValues

allowedValues: string[] = ["Enabled","Disabled"]

name

name: "Enum" = "Enum"

monitoringStatus

monitoringStatus: object

required

required: true = true

serializedName

serializedName: string = "properties.monitoringStatus"

type

type: object

allowedValues

allowedValues: string[] = ["Enabled","Disabled"]

name

name: "Enum" = "Enum"

operationStatus

operationStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.operationStatus"

type

type: object

allowedValues

allowedValues: string[] = ["None","Updating","Deleting","Restoring"]

name

name: "Enum" = "Enum"

sizeInBytes

sizeInBytes: object

required

required: true = true

serializedName

serializedName: string = "properties.sizeInBytes"

type

type: object

name

name: "Number" = "Number"

volumeContainerId

volumeContainerId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.volumeContainerId"

type

type: object

name

name: "String" = "String"

volumeStatus

volumeStatus: object

required

required: true = true

serializedName

serializedName: string = "properties.volumeStatus"

type

type: object

allowedValues

allowedValues: string[] = ["Online","Offline"]

name

name: "Enum" = "Enum"

volumeType

volumeType: object

required

required: true = true

serializedName

serializedName: string = "properties.volumeType"

type

type: object

allowedValues

allowedValues: string[] = ["Tiered","Archival","LocallyPinned"]

name

name: "Enum" = "Enum"

Const VolumeContainer

VolumeContainer: object
interface

An interface representing VolumeContainer. The volume container.

extends

BaseModel

Optional bandWidthRateInMbps

bandWidthRateInMbps: undefined | number
member

{number} [bandWidthRateInMbps] The bandwidth-rate set on the volume container.

Optional bandwidthSettingId

bandwidthSettingId: undefined | string
member

{string} [bandwidthSettingId] The ID of the bandwidth setting associated with the volume container.

Optional encryptionKey

member

{AsymmetricEncryptedSecret} [encryptionKey] The key used to encrypt data in the volume container. It is required when property 'EncryptionStatus' is "Enabled".

Optional encryptionStatus

encryptionStatus: EncryptionStatus
member

{EncryptionStatus} [encryptionStatus] The flag to denote whether encryption is enabled or not. Possible values include: 'Enabled', 'Disabled' NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string
member

{string} [id] The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: Kind
member

{Kind} [kind] The Kind of the object. Currently only Series8000 is supported. Possible values include: 'Series8000'

Optional name

name: undefined | string
member

{string} [name] The name of the object. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ownerShipStatus

ownerShipStatus: OwnerShipStatus
member

{OwnerShipStatus} [ownerShipStatus] The owner ship status of the volume container. Only when the status is "NotOwned", the delete operation on the volume container is permitted. Possible values include: 'Owned', 'NotOwned' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VolumeContainer"

storageAccountCredentialId

storageAccountCredentialId: string
member

{string} storageAccountCredentialId The path ID of storage account associated with the volume container.

Optional totalCloudStorageUsageInBytes

totalCloudStorageUsageInBytes: undefined | number
member

{number} [totalCloudStorageUsageInBytes] The total cloud storage for the volume container. NOTE: This property will not be serialized. It can only be populated by the server.

Optional volumeCount

volumeCount: undefined | number
member

{number} [volumeCount] The number of volumes in the volume Container. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "VolumeContainer"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

bandWidthRateInMbps

bandWidthRateInMbps: object

serializedName

serializedName: string = "properties.bandWidthRateInMbps"

type

type: object

name

name: "Number" = "Number"

bandwidthSettingId

bandwidthSettingId: object

serializedName

serializedName: string = "properties.bandwidthSettingId"

type

type: object

name

name: "String" = "String"

encryptionKey

encryptionKey: object

serializedName

serializedName: string = "properties.encryptionKey"

type

type: object

className

className: string = "AsymmetricEncryptedSecret"

name

name: "Composite" = "Composite"

encryptionStatus

encryptionStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.encryptionStatus"

type

type: object

allowedValues

allowedValues: string[] = ["Enabled","Disabled"]

name

name: "Enum" = "Enum"

ownerShipStatus

ownerShipStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.ownerShipStatus"

type

type: object

allowedValues

allowedValues: string[] = ["Owned","NotOwned"]

name

name: "Enum" = "Enum"

storageAccountCredentialId

storageAccountCredentialId: object

required

required: true = true

serializedName

serializedName: string = "properties.storageAccountCredentialId"

type

type: object

name

name: "String" = "String"

totalCloudStorageUsageInBytes

totalCloudStorageUsageInBytes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.totalCloudStorageUsageInBytes"

type

type: object

name

name: "Number" = "Number"

volumeCount

volumeCount: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.volumeCount"

type

type: object

name

name: "Number" = "Number"

Const VolumeContainerFailoverMetadata

VolumeContainerFailoverMetadata: object
interface

An interface representing VolumeContainerFailoverMetadata. The metadata of the volume container, that is being considered as part of a failover set.

serializedName

serializedName: string = "VolumeContainerFailoverMetadata"

Optional volumeContainerId

volumeContainerId: undefined | string
member

{string} [volumeContainerId] The path ID of the volume container.

Optional volumes

volumes: VolumeFailoverMetadata[]
member

{VolumeFailoverMetadata[]} [volumes] The list of metadata of volumes inside the volume container, which contains valid cloud snapshots.

type

type: object

className

className: string = "VolumeContainerFailoverMetadata"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

volumeContainerId

volumeContainerId: object

serializedName

serializedName: string = "volumeContainerId"

type

type: object

name

name: "String" = "String"

volumes

volumes: object

serializedName

serializedName: string = "volumes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VolumeFailoverMetadata"

name

name: "Composite" = "Composite"

Const VolumeContainerList

VolumeContainerList: object
interface

An interface representing the VolumeContainerList. The collection of volume container entities.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "VolumeContainerList"

__@iterator

  • __@iterator(): IterableIterator<VolumeContainer>
  • Iterator

    Returns IterableIterator<VolumeContainer>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<VolumeContainer>[]): VolumeContainer[]
  • concat(...items: (T | ConcatArray<T>)[]): VolumeContainer[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<VolumeContainer>[]

      Additional items to add to the end of array1.

    Returns VolumeContainer[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns VolumeContainer[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, VolumeContainer]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, VolumeContainer]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: VolumeContainer, index: number, array: VolumeContainer[]): boolean
        • Parameters

          • value: VolumeContainer
          • index: number
          • array: VolumeContainer[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: VolumeContainer, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: VolumeContainer

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): VolumeContainer[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: VolumeContainer

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VolumeContainer, index: number, array: VolumeContainer[]): boolean
        • Parameters

          • value: VolumeContainer
          • index: number
          • array: VolumeContainer[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: VolumeContainer, index: number, array: VolumeContainer[]): any
        • Parameters

          • value: VolumeContainer
          • index: number
          • array: VolumeContainer[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns VolumeContainer[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): VolumeContainer | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: VolumeContainer

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: VolumeContainer, index: number, obj: VolumeContainer[]): boolean
        • Parameters

          • this: void
          • value: VolumeContainer
          • index: number
          • obj: VolumeContainer[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: VolumeContainer, index: number, obj: VolumeContainer[]): boolean
        • Parameters

          • value: VolumeContainer
          • index: number
          • obj: VolumeContainer[]

          Returns boolean

    • Optional thisArg: any

    Returns VolumeContainer | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: VolumeContainer, index: number, obj: VolumeContainer[]): boolean
        • Parameters

          • value: VolumeContainer
          • index: number
          • obj: VolumeContainer[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: VolumeContainer, index: number, array: VolumeContainer[]): void
        • Parameters

          • value: VolumeContainer
          • index: number
          • array: VolumeContainer[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: VolumeContainer, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: VolumeContainer

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: VolumeContainer, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: VolumeContainer

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: VolumeContainer, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: VolumeContainer

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: VolumeContainer, index: number, array: VolumeContainer[]): U
        • Parameters

          • value: VolumeContainer
          • index: number
          • array: VolumeContainer[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): VolumeContainer | undefined
  • Removes the last element from an array and returns it.

    Returns VolumeContainer | undefined

push

  • push(...items: VolumeContainer[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: VolumeContainer[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): VolumeContainer
  • reduce(callbackfn: function, initialValue: VolumeContainer): VolumeContainer
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: VolumeContainer, currentValue: VolumeContainer, currentIndex: number, array: VolumeContainer[]): VolumeContainer
        • Parameters

          • previousValue: VolumeContainer
          • currentValue: VolumeContainer
          • currentIndex: number
          • array: VolumeContainer[]

          Returns VolumeContainer

    Returns VolumeContainer

  • Parameters

    • callbackfn: function
        • (previousValue: VolumeContainer, currentValue: VolumeContainer, currentIndex: number, array: VolumeContainer[]): VolumeContainer
        • Parameters

          • previousValue: VolumeContainer
          • currentValue: VolumeContainer
          • currentIndex: number
          • array: VolumeContainer[]

          Returns VolumeContainer

    • initialValue: VolumeContainer

    Returns VolumeContainer

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VolumeContainer, currentIndex: number, array: VolumeContainer[]): U
        • Parameters

          • previousValue: U
          • currentValue: VolumeContainer
          • currentIndex: number
          • array: VolumeContainer[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): VolumeContainer
  • reduceRight(callbackfn: function, initialValue: VolumeContainer): VolumeContainer
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: VolumeContainer, currentValue: VolumeContainer, currentIndex: number, array: VolumeContainer[]): VolumeContainer
        • Parameters

          • previousValue: VolumeContainer
          • currentValue: VolumeContainer
          • currentIndex: number
          • array: VolumeContainer[]

          Returns VolumeContainer

    Returns VolumeContainer

  • Parameters

    • callbackfn: function
        • (previousValue: VolumeContainer, currentValue: VolumeContainer, currentIndex: number, array: VolumeContainer[]): VolumeContainer
        • Parameters

          • previousValue: VolumeContainer
          • currentValue: VolumeContainer
          • currentIndex: number
          • array: VolumeContainer[]

          Returns VolumeContainer

    • initialValue: VolumeContainer

    Returns VolumeContainer

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: VolumeContainer, currentIndex: number, array: VolumeContainer[]): U
        • Parameters

          • previousValue: U
          • currentValue: VolumeContainer
          • currentIndex: number
          • array: VolumeContainer[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): VolumeContainer[]
  • Reverses the elements in an Array.

    Returns VolumeContainer[]

shift

  • shift(): VolumeContainer | undefined
  • Removes the first element from an array and returns it.

    Returns VolumeContainer | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): VolumeContainer[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns VolumeContainer[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: VolumeContainer, index: number, array: VolumeContainer[]): boolean
        • Parameters

          • value: VolumeContainer
          • index: number
          • array: VolumeContainer[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): VolumeContainer[]
  • splice(start: number, deleteCount: number, ...items: VolumeContainer[]): VolumeContainer[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns VolumeContainer[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: VolumeContainer[]

      Elements to insert into the array in place of the deleted elements.

    Returns VolumeContainer[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: VolumeContainer[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: VolumeContainer[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<VolumeContainer>
  • Returns an iterable of values in the array

    Returns IterableIterator<VolumeContainer>

type

type: object

className

className: string = "VolumeContainerList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VolumeContainer"

name

name: "Composite" = "Composite"

Const VolumeFailoverMetadata

VolumeFailoverMetadata: object
interface

An interface representing VolumeFailoverMetadata. The metadata of a volume that has valid cloud snapshot.

Optional backupCreatedDate

backupCreatedDate: Date
member

{Date} [backupCreatedDate] The date at which the snapshot was taken.

Optional backupElementId

backupElementId: undefined | string
member

{string} [backupElementId] The path ID of the backup-element for this volume, inside the backup set.

Optional backupId

backupId: undefined | string
member

{string} [backupId] The path ID of the backup set.

Optional backupPolicyId

backupPolicyId: undefined | string
member

{string} [backupPolicyId] The path ID of the backup policy using which the snapshot was taken.

serializedName

serializedName: string = "VolumeFailoverMetadata"

Optional sizeInBytes

sizeInBytes: undefined | number
member

{number} [sizeInBytes] The size of the volume in bytes at the time the snapshot was taken.

Optional volumeId

volumeId: undefined | string
member

{string} [volumeId] The path ID of the volume.

Optional volumeType

volumeType: VolumeType
member

{VolumeType} [volumeType] The type of the volume. Possible values include: 'Tiered', 'Archival', 'LocallyPinned'

type

type: object

className

className: string = "VolumeFailoverMetadata"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupCreatedDate

backupCreatedDate: object

serializedName

serializedName: string = "backupCreatedDate"

type

type: object

name

name: "DateTime" = "DateTime"

backupElementId

backupElementId: object

serializedName

serializedName: string = "backupElementId"

type

type: object

name

name: "String" = "String"

backupId

backupId: object

serializedName

serializedName: string = "backupId"

type

type: object

name

name: "String" = "String"

backupPolicyId

backupPolicyId: object

serializedName

serializedName: string = "backupPolicyId"

type

type: object

name

name: "String" = "String"

sizeInBytes

sizeInBytes: object

serializedName

serializedName: string = "sizeInBytes"

type

type: object

name

name: "Number" = "Number"

volumeId

volumeId: object

serializedName

serializedName: string = "volumeId"

type

type: object

name

name: "String" = "String"

volumeType

volumeType: object

serializedName

serializedName: string = "volumeType"

type

type: object

allowedValues

allowedValues: string[] = ["Tiered","Archival","LocallyPinned"]

name

name: "Enum" = "Enum"

Const VolumeList

VolumeList: object
interface

An interface representing the VolumeList. The collection of volumes.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "VolumeList"

__@iterator

  • __@iterator(): IterableIterator<Volume>
  • Iterator

    Returns IterableIterator<Volume>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Volume>[]): Volume[]
  • concat(...items: (T | ConcatArray<T>)[]): Volume[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Volume>[]

      Additional items to add to the end of array1.

    Returns Volume[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Volume[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Volume]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Volume]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Volume, index: number, array: Volume[]): boolean
        • Parameters

          • value: Volume
          • index: number
          • array: Volume[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Volume, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Volume

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Volume[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Volume

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Volume, index: number, array: Volume[]): boolean
        • Parameters

          • value: Volume
          • index: number
          • array: Volume[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Volume, index: number, array: Volume[]): any
        • Parameters

          • value: Volume
          • index: number
          • array: Volume[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Volume[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Volume | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Volume

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Volume, index: number, obj: Volume[]): boolean
        • Parameters

          • this: void
          • value: Volume
          • index: number
          • obj: Volume[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Volume, index: number, obj: Volume[]): boolean
        • Parameters

          • value: Volume
          • index: number
          • obj: Volume[]

          Returns boolean

    • Optional thisArg: any

    Returns Volume | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Volume, index: number, obj: Volume[]): boolean
        • Parameters

          • value: Volume
          • index: number
          • obj: Volume[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Volume, index: number, array: Volume[]): void
        • Parameters

          • value: Volume
          • index: number
          • array: Volume[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Volume, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Volume

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Volume, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Volume

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Volume, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Volume

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Volume, index: number, array: Volume[]): U
        • Parameters

          • value: Volume
          • index: number
          • array: Volume[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Volume | undefined
  • Removes the last element from an array and returns it.

    Returns Volume | undefined

push

  • push(...items: Volume[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Volume[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Volume
  • reduce(callbackfn: function, initialValue: Volume): Volume
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Volume, currentValue: Volume, currentIndex: number, array: Volume[]): Volume
        • Parameters

          • previousValue: Volume
          • currentValue: Volume
          • currentIndex: number
          • array: Volume[]

          Returns Volume

    Returns Volume

  • Parameters

    • callbackfn: function
        • (previousValue: Volume, currentValue: Volume, currentIndex: number, array: Volume[]): Volume
        • Parameters

          • previousValue: Volume
          • currentValue: Volume
          • currentIndex: number
          • array: Volume[]

          Returns Volume

    • initialValue: Volume

    Returns Volume

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Volume, currentIndex: number, array: Volume[]): U
        • Parameters

          • previousValue: U
          • currentValue: Volume
          • currentIndex: number
          • array: Volume[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Volume
  • reduceRight(callbackfn: function, initialValue: Volume): Volume
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Volume, currentValue: Volume, currentIndex: number, array: Volume[]): Volume
        • Parameters

          • previousValue: Volume
          • currentValue: Volume
          • currentIndex: number
          • array: Volume[]

          Returns Volume

    Returns Volume

  • Parameters

    • callbackfn: function
        • (previousValue: Volume, currentValue: Volume, currentIndex: number, array: Volume[]): Volume
        • Parameters

          • previousValue: Volume
          • currentValue: Volume
          • currentIndex: number
          • array: Volume[]

          Returns Volume

    • initialValue: Volume

    Returns Volume

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Volume, currentIndex: number, array: Volume[]): U
        • Parameters

          • previousValue: U
          • currentValue: Volume
          • currentIndex: number
          • array: Volume[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Volume[]
  • Reverses the elements in an Array.

    Returns Volume[]

shift

  • shift(): Volume | undefined
  • Removes the first element from an array and returns it.

    Returns Volume | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Volume[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Volume[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Volume, index: number, array: Volume[]): boolean
        • Parameters

          • value: Volume
          • index: number
          • array: Volume[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Volume[]
  • splice(start: number, deleteCount: number, ...items: Volume[]): Volume[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Volume[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Volume[]

      Elements to insert into the array in place of the deleted elements.

    Returns Volume[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Volume[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Volume[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Volume>
  • Returns an iterable of values in the array

    Returns IterableIterator<Volume>

type

type: object

className

className: string = "VolumeList"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Volume"

name

name: "Composite" = "Composite"

Const WebproxySettings

WebproxySettings: object
interface

An interface representing WebproxySettings. The web proxy settings on the device.

authentication

authentication: AuthenticationType
member

{AuthenticationType} authentication The authentication type. Possible values include: 'Invalid', 'None', 'Basic', 'NTLM'

Optional connectionUri

connectionUri: undefined | string
member

{string} [connectionUri] The connection URI.

serializedName

serializedName: string = "WebproxySettings"

username

username: string
member

{string} username The webproxy username.

type

type: object

className

className: string = "WebproxySettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authentication

authentication: object

required

required: true = true

serializedName

serializedName: string = "authentication"

type

type: object

allowedValues

allowedValues: string[] = ["Invalid","None","Basic","NTLM"]

name

name: "Enum" = "Enum"

connectionUri

connectionUri: object

serializedName

serializedName: string = "connectionUri"

type

type: object

name

name: "String" = "String"

username

username: object

required

required: true = true

serializedName

serializedName: string = "username"

type

type: object

name

name: "String" = "String"

Const acceptLanguage

acceptLanguage: object

parameterPath

parameterPath: string = "acceptLanguage"

mapper

mapper: object

defaultValue

defaultValue: string = "en-US"

serializedName

serializedName: string = "accept-language"

type

type: object

name

name: "String" = "String"

Const accessControlRecordName

accessControlRecordName: object

parameterPath

parameterPath: string = "accessControlRecordName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "accessControlRecordName"

type

type: object

name

name: "String" = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const backupElementName

backupElementName: object

parameterPath

parameterPath: string = "backupElementName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "backupElementName"

type

type: object

name

name: "String" = "String"

Const backupName

backupName: object

parameterPath

parameterPath: string = "backupName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "backupName"

type

type: object

name

name: "String" = "String"

Const backupPolicyName

backupPolicyName: object

parameterPath

parameterPath: string = "backupPolicyName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "backupPolicyName"

type

type: object

name

name: "String" = "String"

Const backupScheduleName

backupScheduleName: object

parameterPath

parameterPath: string = "backupScheduleName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "backupScheduleName"

type

type: object

name

name: "String" = "String"

Const backupType

backupType: object

parameterPath

parameterPath: string = "backupType"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "backupType"

type

type: object

name

name: "String" = "String"

Const bandwidthSettingName

bandwidthSettingName: object

parameterPath

parameterPath: string = "bandwidthSettingName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "bandwidthSettingName"

type

type: object

name

name: "String" = "String"

Const deviceName

deviceName: object

parameterPath

parameterPath: string = "deviceName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "deviceName"

type

type: object

name

name: "String" = "String"

Const expand

expand: object

parameterPath

parameterPath: string[] = ["options","expand"]

mapper

mapper: object

serializedName

serializedName: string = "$expand"

type

type: object

name

name: "String" = "String"

Const filter0

filter0: object

parameterPath

parameterPath: string[] = ["options","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const filter1

filter1: object

parameterPath

parameterPath: string = "filter"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const hardwareComponentGroupName

hardwareComponentGroupName: object

parameterPath

parameterPath: string = "hardwareComponentGroupName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "hardwareComponentGroupName"

type

type: object

name

name: "String" = "String"

Const ifMatch

ifMatch: object

parameterPath

parameterPath: string = "ifMatch"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: "String" = "String"

Const jobName

jobName: object

parameterPath

parameterPath: string = "jobName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "jobName"

type

type: object

name

name: "String" = "String"

Const managerName

managerName: object

parameterPath

parameterPath: string = "managerName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "managerName"

constraints

constraints: object

MaxLength

MaxLength: number = 50

MinLength

MinLength: number = 2

type

type: object

name

name: "String" = "String"

Const nextPageLink

nextPageLink: object

parameterPath

parameterPath: string = "nextPageLink"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

Const resourceGroupName

resourceGroupName: object

parameterPath

parameterPath: string = "resourceGroupName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "resourceGroupName"

type

type: object

name

name: "String" = "String"

Const sourceDeviceName

sourceDeviceName: object

parameterPath

parameterPath: string = "sourceDeviceName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "sourceDeviceName"

type

type: object

name

name: "String" = "String"

Const storageAccountCredentialName

storageAccountCredentialName: object

parameterPath

parameterPath: string = "storageAccountCredentialName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "storageAccountCredentialName"

type

type: object

name

name: "String" = "String"

Const subscriptionId

subscriptionId: object

parameterPath

parameterPath: string = "subscriptionId"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

Const volumeContainerName

volumeContainerName: object

parameterPath

parameterPath: string = "volumeContainerName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "volumeContainerName"

type

type: object

name

name: "String" = "String"

Const volumeName

volumeName: object

parameterPath

parameterPath: string = "volumeName"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "volumeName"

type

type: object

name

name: "String" = "String"

Generated using TypeDoc